Merge pull request #1745 from AnalyticalGraphicsInc/jsDocUpgrade

Upgrade JSDoc to 3.3.0-alpha 5

Author: pjcozzi

.gitignore

@@ -18,4 +18,6 @@ Thumbs.db
 /Source/Shaders/*/*/*.js
 !/Source/Shaders/Shaders.profile.js
 
-/Specs/SpecList.js
+/Specs/SpecList.js
+
+/node_modules

.project

@@ -32,7 +32,7 @@
 	</natures>
 	<filteredResources>
 		<filter>
-			<id>1391456479002</id>
+			<id>1400616658988</id>
 			<name></name>
 			<type>10</type>
 			<matcher>
@@ -41,7 +41,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1391456479007</id>
+			<id>1400616658995</id>
 			<name></name>
 			<type>10</type>
 			<matcher>
@@ -50,7 +50,7 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1391456479012</id>
+			<id>1400616658999</id>
 			<name></name>
 			<type>6</type>
 			<matcher>
@@ -59,14 +59,23 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1391456479018</id>
+			<id>1400616659006</id>
 			<name></name>
 			<type>10</type>
 			<matcher>
 				<id>org.eclipse.ui.ide.multiFilter</id>
 				<arguments>1.0-name-matches-false-false-.git</arguments>
 			</matcher>
 		</filter>
+		<filter>
+			<id>1400616659012</id>
+			<name></name>
+			<type>10</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-node_modules</arguments>
+			</matcher>
+		</filter>
 		<filter>
 			<id>1336749023862</id>
 			<name>Source</name>
@@ -86,14 +95,23 @@
 			</matcher>
 		</filter>
 		<filter>
-			<id>1348694184349</id>
+			<id>1400616508068</id>
 			<name>Tools</name>
 			<type>9</type>
 			<matcher>
 				<id>org.eclipse.ui.ide.multiFilter</id>
 				<arguments>1.0-name-matches-false-false-buildTasks</arguments>
 			</matcher>
 		</filter>
+		<filter>
+			<id>1400616508072</id>
+			<name>Tools</name>
+			<type>9</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-false-false-jsdoc</arguments>
+			</matcher>
+		</filter>
 		<filter>
 			<id>1360870693679</id>
 			<name>Apps/Sandcastle</name>

.settings/com.eclipsesource.jshint.ui.prefs

@@ -1,4 +1,4 @@
 eclipse.preferences.version=1
-excluded=Apps/Sandcastle/ThirdParty//*\:Source/ThirdParty//*\:Source/Workers/cesiumWorkerBootstrapper.js\:ThirdParty//*\:Tools/build.js
+excluded=Apps/Sandcastle/ThirdParty//*\:Source/ThirdParty//*\:Source/Workers/cesiumWorkerBootstrapper.js\:ThirdParty//*\:Tools/build.js\:Tools/jsdoc//*
 included=//*.js
 projectSpecificOptions=true

CHANGES.md

@@ -45,7 +45,8 @@ Beta Releases
 * `Camera.transform` now works consistently across scene modes.
 * Fixed a bug that prevented `sampleTerrain` from working with STK World Terrain in Firefox.
 * `sampleTerrain` no longer fails when used with a `TerrainProvider` that is not yet ready.
-* Updated Dojo from 1.9.1 to 1.9.3. NOTE: Dojo is only used in Sandcastle and not required by Cesium.
+* Upgraded JSDoc from 3.0 to 3.3.0-alpha5. The Cesium reference documentation now has a slightly different look and feel.
+* Upgraded Dojo from 1.9.1 to 1.9.3. NOTE: Dojo is only used in Sandcastle and not required by Cesium.
 
 ### b28 - 2014-05-01
 

Specs/SpecRunner.js

@@ -35,11 +35,7 @@ var afterAll;
 
     function getQueryParameter(name) {
         var match = new RegExp('[?&]' + name + '=([^&]*)').exec(window.location.search);
-
-        if (match) {
-            return decodeURIComponent(match[1].replace(/\+/g, ' '));
-        }
-        return null;
+        return match && decodeURIComponent(match[1].replace(/\+/g, ' '));
     }
 
     // patch in beforeAll/afterAll functions

Tools/jsdoc/cesiumTags.js

@@ -0,0 +1,39 @@
+exports.defineTags = function(dictionary) {
+    dictionary.lookUp('class').synonym('internalConstructor');
+
+    dictionary.defineTag('exports', {
+        mustHaveValue : true,
+        onTagged : function(doclet, tag) {
+            doclet.addTag('alias', tag.value);
+            doclet.addTag('kind', 'module');
+            doclet.longname = tag.value;
+        }
+    }).synonym('enumeration');
+
+    dictionary.defineTag('glsl', {
+        onTagged : function(doclet, tag) {
+            doclet.addTag('kind', 'glsl');
+            doclet.filename = doclet.name;
+        }
+    }).synonym('glslStruct').synonym('glslUniform').synonym('glslConstant').synonym('glslFunction');
+
+    dictionary.defineTag('performance', {
+        mustHaveValue : true,
+        onTagged : function(doclet, tag) {
+            if (!doclet.performance) {
+                doclet.performance = [];
+            }
+            doclet.performance.push(tag.value);
+        }
+    });
+
+    dictionary.defineTag('demo', {
+        mustHaveValue : true,
+        onTagged : function(doclet, tag) {
+            if (!doclet.demo) {
+                doclet.demo = [];
+            }
+            doclet.demo.push(tag.value);
+        }
+    });
+};