Reorganized style guides and IDE files

Moved IDE style guide files to separate folder and renamed style guide web files to match their corresponding languages
calcmogul · Jan 2, 2018 · 0f4d4e8 · 0f4d4e8
1 parent d08f472
commit 0f4d4e8
Show file tree

Hide file tree

Showing 13 changed files with 90 additions and 1,011 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,8 @@ This repository contains our style guides for C++ and Java code, various IDE sup
 
 Anything submitted to a wpilibsuite project needs to follow the code style guides outlined here. For details about the style, please see the contributors document [here](CONTRIBUTING.md#coding-guidelines).
 
+Style configuration files for IDEs are in the [ide](ide) folder. The style guides for C++, Java, and Python are named `cppguide`, `javaguide`, and `pyguide` respectively.
+
 ## Setup
 
 See the `wpiformat` Python package [README](wpiformat/README.rst).

diff --git a/include/styleguide.css → cppguide.css b/include/styleguide.css → cppguide.css
diff --git a/cppguide.html b/cppguide.html
@@ -3,8 +3,8 @@
 <head>
 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
 <title>WPILib C++ Style Guide</title>
-<link rel="stylesheet" type="text/css" href="include/styleguide.css">
-<script language="javascript" src="include/styleguide.js"></script>
+<link rel="stylesheet" type="text/css" href="cppguide.css">
+<script language="javascript" src="cppguide.js"></script>
 </head>
 <body onload="initStyleGuide();">
 <div id="content">

diff --git a/include/styleguide.js → cppguide.js b/include/styleguide.js → cppguide.js
@@ -247,7 +247,7 @@ function LinkifyHeader(header, fileName, sizePixels) {
   link.href = '#' + header.id;
   link.alt = 'link to ' + header.id;
   link.innerHTML =
-      '<img src="include/' + fileName + '"' +
+      '<img src="' + fileName + '"' +
       ' width=' + sizePixels +
       ' height=' + sizePixels +
       ' style="float:left;position:relative;bottom:5px;">';
@@ -263,7 +263,7 @@ function LinkifyHeadersForTag(tagName) {
     header = headers[j];
     if (!hasClass(header, 'ignoreLink') && ('id' in header)) {
       if (header.id != '') {
-        LinkifyHeader(header, 'link.png', 21);
+        LinkifyHeader(header, 'guidelink.png', 21);
         header.style.left = '-46px';
         header.style.position = 'relative';
       }

diff --git a/include/link.png → guidelink.png b/include/link.png → guidelink.png
diff --git a/eclipse-cpp-google-style.xml → ide/eclipse-cpp-google-style.xml b/eclipse-cpp-google-style.xml → ide/eclipse-cpp-google-style.xml
diff --git a/eclipse-java-google-style.xml → ide/eclipse-java-google-style.xml b/eclipse-java-google-style.xml → ide/eclipse-java-google-style.xml
diff --git a/intellij-java-google-style.xml → ide/intellij-java-google-style.xml b/intellij-java-google-style.xml → ide/intellij-java-google-style.xml
diff --git a/javaguide.html b/javaguide.html
diff --git a/javaguidelink.png b/javaguidelink.png
diff --git a/styleguide.css → pyguide.css b/styleguide.css → pyguide.css
diff --git a/pyguide.html b/pyguide.html
@@ -3,7 +3,7 @@
 <TITLE>Google Python Style Guide</TITLE>
 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
 <LINK HREF="https://www.google.com/favicon.ico" type="image/x-icon" rel="shortcut icon">
-<LINK HREF="styleguide.css" type="text/css" rel="stylesheet">
+<LINK HREF="pyguide.css" type="text/css" rel="stylesheet">
 <SCRIPT language="javascript" type="text/javascript">
 
                 function GetElementsByName(name) {