Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade JSDoc to 3.3.0-alpha 5 #1745

Merged
merged 6 commits into from
May 26, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ Thumbs.db
/Source/Shaders/*/*/*.js
!/Source/Shaders/Shaders.profile.js

/Specs/SpecList.js
/Specs/SpecList.js

/node_modules
28 changes: 23 additions & 5 deletions .project
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
</natures>
<filteredResources>
<filter>
<id>1391456479002</id>
<id>1400616658988</id>
<name></name>
<type>10</type>
<matcher>
Expand All @@ -41,7 +41,7 @@
</matcher>
</filter>
<filter>
<id>1391456479007</id>
<id>1400616658995</id>
<name></name>
<type>10</type>
<matcher>
Expand All @@ -50,7 +50,7 @@
</matcher>
</filter>
<filter>
<id>1391456479012</id>
<id>1400616658999</id>
<name></name>
<type>6</type>
<matcher>
Expand All @@ -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>
Expand All @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion .settings/com.eclipsesource.jshint.ui.prefs
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 1 addition & 5 deletions Specs/SpecRunner.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
39 changes: 39 additions & 0 deletions Tools/jsdoc/cesiumTags.js
Original file line number Diff line number Diff line change
@@ -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);
}
});
};
Loading