Skip to content

Commit 4782dc7

Browse files
shuntershunter
committedMay 23, 2014
JSDoc upgrade work in progress
·
b301.0
1 parent cb44065 commit 4782dc7

35 files changed

+2676
-12
lines changed
 

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ Thumbs.db
1818
/Source/Shaders/*/*/*.js
1919
!/Source/Shaders/Shaders.profile.js
2020

21-
/Specs/SpecList.js
21+
/Specs/SpecList.js
22+
23+
/node_modules

‎.project

+23-5
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
</natures>
3333
<filteredResources>
3434
<filter>
35-
<id>1391456479002</id>
35+
<id>1400616658988</id>
3636
<name></name>
3737
<type>10</type>
3838
<matcher>
@@ -41,7 +41,7 @@
4141
</matcher>
4242
</filter>
4343
<filter>
44-
<id>1391456479007</id>
44+
<id>1400616658995</id>
4545
<name></name>
4646
<type>10</type>
4747
<matcher>
@@ -50,7 +50,7 @@
5050
</matcher>
5151
</filter>
5252
<filter>
53-
<id>1391456479012</id>
53+
<id>1400616658999</id>
5454
<name></name>
5555
<type>6</type>
5656
<matcher>
@@ -59,14 +59,23 @@
5959
</matcher>
6060
</filter>
6161
<filter>
62-
<id>1391456479018</id>
62+
<id>1400616659006</id>
6363
<name></name>
6464
<type>10</type>
6565
<matcher>
6666
<id>org.eclipse.ui.ide.multiFilter</id>
6767
<arguments>1.0-name-matches-false-false-.git</arguments>
6868
</matcher>
6969
</filter>
70+
<filter>
71+
<id>1400616659012</id>
72+
<name></name>
73+
<type>10</type>
74+
<matcher>
75+
<id>org.eclipse.ui.ide.multiFilter</id>
76+
<arguments>1.0-name-matches-false-false-node_modules</arguments>
77+
</matcher>
78+
</filter>
7079
<filter>
7180
<id>1336749023862</id>
7281
<name>Source</name>
@@ -86,14 +95,23 @@
8695
</matcher>
8796
</filter>
8897
<filter>
89-
<id>1348694184349</id>
98+
<id>1400616508068</id>
9099
<name>Tools</name>
91100
<type>9</type>
92101
<matcher>
93102
<id>org.eclipse.ui.ide.multiFilter</id>
94103
<arguments>1.0-name-matches-false-false-buildTasks</arguments>
95104
</matcher>
96105
</filter>
106+
<filter>
107+
<id>1400616508072</id>
108+
<name>Tools</name>
109+
<type>9</type>
110+
<matcher>
111+
<id>org.eclipse.ui.ide.multiFilter</id>
112+
<arguments>1.0-name-matches-false-false-jsdoc</arguments>
113+
</matcher>
114+
</filter>
97115
<filter>
98116
<id>1360870693679</id>
99117
<name>Apps/Sandcastle</name>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
eclipse.preferences.version=1
2-
excluded=Apps/Sandcastle/ThirdParty//*\:Source/ThirdParty//*\:Source/Workers/cesiumWorkerBootstrapper.js\:ThirdParty//*\:Tools/build.js
2+
excluded=Apps/Sandcastle/ThirdParty//*\:Source/ThirdParty//*\:Source/Workers/cesiumWorkerBootstrapper.js\:ThirdParty//*\:Tools/build.js\:Tools/jsdoc//*
33
included=//*.js
44
projectSpecificOptions=true

‎Specs/SpecRunner.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,7 @@ var afterAll;
3535

3636
function getQueryParameter(name) {
3737
var match = new RegExp('[?&]' + name + '=([^&]*)').exec(window.location.search);
38-
39-
if (match) {
40-
return decodeURIComponent(match[1].replace(/\+/g, ' '));
41-
}
42-
return null;
38+
return match && decodeURIComponent(match[1].replace(/\+/g, ' '));
4339
}
4440

4541
// patch in beforeAll/afterAll functions

‎Tools/jsdoc/cesiumTags.js

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/**
2+
@overview Define custom tags for Cesium
3+
@author Kristian Calhoun <kristian.calhoun@gmail.com>
4+
*/
5+
6+
exports.defineTags = function(dictionary) {
7+
8+
dictionary.lookUp('class').synonym('internalConstructor');
9+
10+
dictionary.defineTag('exports', {
11+
mustHaveValue: true,
12+
onTagged: function(doclet, tag) {
13+
doclet.addTag('alias', tag.value);
14+
doclet.addTag('kind', 'module');
15+
doclet.longname = tag.value;
16+
}
17+
}).synonym('enumeration');
18+
19+
dictionary.defineTag('glsl', {
20+
onTagged: function(doclet, tag) {
21+
doclet.addTag('kind', 'glsl');
22+
doclet.filename = doclet.name;
23+
}
24+
}).synonym('glslStruct').synonym('glslUniform').synonym('glslConstant').synonym('glslFunction');
25+
26+
dictionary.defineTag('performance', {
27+
mustHaveValue: true,
28+
onTagged: function(doclet, tag) {
29+
if (!doclet.performance) { doclet.performance = []; }
30+
doclet.performance.push(tag.value);
31+
}
32+
});
33+
34+
dictionary.defineTag('demo', {
35+
mustHaveValue: true,
36+
onTagged: function(doclet, tag) {
37+
if (!doclet.demo) { doclet.demo = []; }
38+
doclet.demo.push(tag.value);
39+
}
40+
});
41+
};

‎Tools/jsdoc/cesium_template/publish.js

+427
Large diffs are not rendered by default.

‎Tools/jsdoc/cesium_template/static/icons/home.png

327 Bytes
Loading

‎Tools/jsdoc/cesium_template/static/icons/popout.png

398 Bytes
Loading

‎Tools/jsdoc/cesium_template/static/javascript/cesiumDoc.js

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
(function() {
2+
3+
SyntaxHighlighter.all();
4+
5+
var filterType = document.getElementById('filterType');
6+
var classFilter = document.getElementById('ClassFilter');
7+
var classList = document.getElementById('ClassList');
8+
9+
function filter() {
10+
var value = classFilter.value.toLowerCase();
11+
12+
var items = classList.getElementsByTagName('li');
13+
for (var i = 0; i < items.length; i++) {
14+
var item = items[i];
15+
var itemName = item.getAttribute('data-name') || '';
16+
itemName = itemName.toLowerCase().replace(/\s/g, '');
17+
if (itemName.indexOf(value) >= 0) {
18+
item.style.display = '';
19+
} else {
20+
item.style.display = 'none';
21+
}
22+
}
23+
}
24+
classFilter.onkeyup = filter;
25+
26+
function getQueryParameter(name) {
27+
var match = new RegExp('[?&]' + name + '=([^&]*)').exec(window.location.search);
28+
return match && decodeURIComponent(match[1].replace(/\+/g, ' '));
29+
}
30+
31+
var show = getQueryParameter('show');
32+
if (show) {
33+
document.getElementById('filterType').value = show;
34+
}
35+
36+
var searchTerm = getQueryParameter('classFilter') || '';
37+
classFilter.value = searchTerm;
38+
filter();
39+
40+
function resetFilter() {
41+
classFilter.value = '';
42+
filter();
43+
}
44+
45+
function updateMenuLinks() {
46+
var links = classList.getElementsByTagName('a');
47+
var searchTerm = classFilter.value;
48+
for (var i = 0; i < links.length; i++) {
49+
var link = links[i];
50+
var prefix = link.href.split('?')[0];
51+
link.href = prefix + (searchTerm === '' ? '' : '?classFilter=' + searchTerm);
52+
}
53+
}
54+
55+
var menuLinks = classList.getElementsByTagName('a');
56+
for (var i = 0; i < menuLinks.length; i++) {
57+
menuLinks[i].onclick = function() {
58+
updateMenuLinks();
59+
}
60+
}
61+
})();

‎Tools/jsdoc/cesium_template/static/javascript/html5.js

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Tools/jsdoc/cesium_template/static/javascript/shBrushJScript.js

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
/**
2+
* SyntaxHighlighter
3+
* http://alexgorbatchev.com/SyntaxHighlighter
4+
*
5+
* SyntaxHighlighter is donationware. If you are using it, please donate.
6+
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
7+
*
8+
* @version
9+
* 3.0.83 (July 02 2010)
10+
*
11+
* @copyright
12+
* Copyright (C) 2004-2010 Alex Gorbatchev.
13+
*
14+
* @license
15+
* Dual licensed under the MIT and GPL licenses.
16+
*/
17+
(function()
18+
{
19+
// CommonJS
20+
typeof(require) != 'undefined' ? SyntaxHighlighter = require('shCore').SyntaxHighlighter : null;
21+
22+
function Brush()
23+
{
24+
var keywords = 'break case catch continue ' +
25+
'default delete do else false ' +
26+
'for function if in instanceof ' +
27+
'new null return super switch ' +
28+
'this throw true try typeof var while with' +
29+
// GLSL keywords
30+
'attribute const uniform varying ' +
31+
'layout centroid flat smooth ' +
32+
'noperspective break continue do ' +
33+
'for while switch case default if ' +
34+
'else in out inout float int void ' +
35+
'bool true false invariant discard ' +
36+
'return mat2 mat3 mat4 mat2x2 mat2x3 ' +
37+
'mat2x4 mat3x2 mat3x3 mat3x4 mat4x2 ' +
38+
'mat4x3 mat4x4 vec2 vec3 vec4 ivec2 ' +
39+
'ivec3 ivec4 bvec2 bvec3 bvec4 uint ' +
40+
'uvec2 uvec3 uvec4 lowp mediump highp ' +
41+
'precision sampler1D sampler2D sampler3D ' +
42+
'samplerCube sampler1DShadow ' +
43+
'sampler2DShadow samplerCubeShadow ' +
44+
'sampler1DArray sampler2DArray ' +
45+
'sampler1DArrayShadow sampler2DArrayShadow ' +
46+
'isampler1D isampler2D isampler3D ' +
47+
'isamplerCube isampler1DArray ' +
48+
'isampler2DArray usampler1D usampler2D ' +
49+
'usampler3D usamplerCube usampler1DArray ' +
50+
'usampler2DArray sampler2DRect ' +
51+
'sampler2DRectShadow isampler2DRect ' +
52+
'usampler2DRect samplerBuffer ' +
53+
'isamplerBuffer usamplerBuffer sampler2DMS ' +
54+
'isampler2DMS usampler2DMS ' +
55+
'sampler2DMSArray isampler2DMSArray ' +
56+
'usampler2DMSArray struct ' +
57+
'radians degrees sin cos tan asin acos atan ' +
58+
'atan sinh cosh tanh asinh acosh atanh pow ' +
59+
'exp log exp2 log2 sqrt inversesqrt abs sign ' +
60+
'floor trunc round roundEven ceil fract mod modf ' +
61+
'min max clamp mix step smoothstep isnan isinf ' +
62+
'floatBitsToInt floatBitsToUint intBitsToFloat ' +
63+
'uintBitsToFloat length distance dot cross ' +
64+
'normalize faceforward reflect refract ' +
65+
'matrixCompMult outerProduct transpose ' +
66+
'determinant inverse lessThan lessThanEqual ' +
67+
'greaterThan greaterThanEqual equal notEqual ' +
68+
'any all not textureSize texture textureProj ' +
69+
'textureLod textureOffset texelFetch ' +
70+
'texelFetchOffset textureProjOffset ' +
71+
'textureLodOffset textureProjLod ' +
72+
'textureProjLodOffset textureGrad ' +
73+
'textureGradOffset textureProjGrad ' +
74+
'textureProjGradOffset texture1D texture1DProj ' +
75+
'texture1DProjLod texture2D texture2DProj ' +
76+
'texture2DLod texture2DProjLod texture3D ' +
77+
'texture3DProj texture3DLod texture3DProjLod ' +
78+
'textureCube textureCubeLod shadow1D shadow2D ' +
79+
'shadow1DProj shadow2DProj shadow1DLod ' +
80+
'shadow2DLod shadow1DProjLod shadow2DProjLod ' +
81+
'dFdx dFdy fwidth noise1 noise2 noise3 noise4 ' +
82+
'EmitVertex EndPrimitive' +
83+
'gl_VertexID gl_InstanceID gl_Position ' +
84+
'gl_PointSize gl_ClipDistance gl_PerVertex ' +
85+
'gl_Layer gl_ClipVertex gl_FragCoord ' +
86+
'gl_FrontFacing gl_ClipDistance gl_FragColor ' +
87+
'gl_FragData gl_MaxDrawBuffers gl_FragDepth ' +
88+
'gl_PointCoord gl_PrimitiveID ' +
89+
'gl_MaxVertexAttribs gl_MaxVertexUniformComponents ' +
90+
'gl_MaxVaryingFloats gl_MaxVaryingComponents ' +
91+
'gl_MaxVertexOutputComponents ' +
92+
'gl_MaxGeometryInputComponents ' +
93+
'gl_MaxGeometryOutputComponents ' +
94+
'gl_MaxFragmentInputComponents ' +
95+
'gl_MaxVertexTextureImageUnits ' +
96+
'gl_MaxCombinedTextureImageUnits ' +
97+
'gl_MaxTextureImageUnits ' +
98+
'gl_MaxFragmentUniformComponents ' +
99+
'gl_MaxDrawBuffers gl_MaxClipDistances ' +
100+
'gl_MaxGeometryTextureImageUnits ' +
101+
'gl_MaxGeometryOutputVertices ' +
102+
'gl_MaxGeometryOutputVertices ' +
103+
'gl_MaxGeometryTotalOutputComponents ' +
104+
'gl_MaxGeometryUniformComponents ' +
105+
'gl_MaxGeometryVaryingComponents gl_DepthRange';
106+
107+
var links = document.links;
108+
var numLinks = links.length;
109+
var symbols = [];
110+
for (var i =0; i < numLinks; i++) {
111+
var currentLink = links[i].href;
112+
var start = currentLink.lastIndexOf("/");
113+
var end = currentLink.lastIndexOf(".html");
114+
var symbolName = currentLink.slice(start + 1.0, end);
115+
var periodIndex = symbolName.indexOf(".");
116+
if(periodIndex !== -1) {
117+
symbolName = symbolName.slice(periodIndex + 1.0);
118+
}
119+
if (start !== -1) {
120+
symbols.push(symbolName);
121+
}
122+
}
123+
124+
var numSymbols = symbols.length;
125+
var symbolKeywords = "";
126+
for (i = 0; i < numSymbols; i++) {
127+
if(symbols[i] !== "") {
128+
symbolKeywords += symbols[i] + " ";
129+
}
130+
}
131+
132+
var r = SyntaxHighlighter.regexLib;
133+
var agi_model = "agi_model";
134+
this.regexList = [
135+
{ regex: r.multiLineDoubleQuotedString, css: 'string' }, // double quoted strings
136+
{ regex: r.multiLineSingleQuotedString, css: 'string' }, // single quoted strings
137+
{ regex: r.singleLineCComments, css: 'comments' }, // one line comments
138+
{ regex: r.multiLineCComments, css: 'comments' }, // multiline comments
139+
{ regex: /\s*#.*/gm, css: 'preprocessor' }, // preprocessor tags like #region and #endregion
140+
{ regex: new RegExp(this.getKeywords(keywords), 'gm'), css: 'keyword' }, // keywords
141+
{ regex: new RegExp(this.getKeywords(symbolKeywords), 'gm'), css: 'symbol'} // symbol
142+
];
143+
144+
this.forHtmlScript(r.scriptScriptTags);
145+
};
146+
147+
Brush.prototype = new SyntaxHighlighter.Highlighter();
148+
Brush.aliases = ['js', 'jscript', 'javascript'];
149+
150+
SyntaxHighlighter.brushes.JScript = Brush;
151+
152+
// CommonJS
153+
typeof(exports) != 'undefined' ? exports.Brush = Brush : null;
154+
})();

‎Tools/jsdoc/cesium_template/static/javascript/shCore.js

+17
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Tools/jsdoc/cesium_template/static/styles/jsdoc-default.css

+586
Large diffs are not rendered by default.

‎Tools/jsdoc/cesium_template/static/styles/node-dark.css

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
.sh_sourceCode {
2+
background-color: #ffffff;
3+
color: #000000;
4+
font-weight: normal;
5+
font-style: normal;
6+
}
7+
8+
.sh_sourceCode .sh_keyword {
9+
color: #000000;
10+
font-weight: bold;
11+
font-style: normal;
12+
}
13+
14+
.sh_sourceCode .sh_type {
15+
color: #a52a2a;
16+
font-weight: bold;
17+
font-style: normal;
18+
}
19+
20+
.sh_sourceCode .sh_string {
21+
color: #006400;
22+
font-weight: normal;
23+
font-style: normal;
24+
}
25+
26+
.sh_sourceCode .sh_regexp {
27+
color: #006400;
28+
font-weight: normal;
29+
font-style: normal;
30+
}
31+
32+
.sh_sourceCode .sh_specialchar {
33+
color: #2e8b57;
34+
font-weight: normal;
35+
font-style: normal;
36+
}
37+
38+
.sh_sourceCode .sh_comment {
39+
color: #000000;
40+
font-weight: normal;
41+
font-style: italic;
42+
}
43+
44+
.sh_sourceCode .sh_number {
45+
color: #006400;
46+
font-weight: normal;
47+
font-style: normal;
48+
}
49+
50+
.sh_sourceCode .sh_preproc {
51+
color: #27408b;
52+
font-weight: normal;
53+
font-style: normal;
54+
}
55+
56+
.sh_sourceCode .sh_symbol {
57+
color: #000000;
58+
font-weight: bold;
59+
font-style: normal;
60+
}
61+
62+
.sh_sourceCode .sh_function {
63+
color: #000000;
64+
font-weight: normal;
65+
font-style: normal;
66+
}
67+
68+
.sh_sourceCode .sh_cbracket {
69+
color: #000000;
70+
font-weight: bold;
71+
font-style: normal;
72+
}
73+
74+
.sh_sourceCode .sh_url {
75+
color: #006400;
76+
font-weight: normal;
77+
font-style: normal;
78+
}
79+
80+
.sh_sourceCode .sh_date {
81+
color: #000000;
82+
font-weight: bold;
83+
font-style: normal;
84+
}
85+
86+
.sh_sourceCode .sh_time {
87+
color: #000000;
88+
font-weight: bold;
89+
font-style: normal;
90+
}
91+
92+
.sh_sourceCode .sh_file {
93+
color: #000000;
94+
font-weight: bold;
95+
font-style: normal;
96+
}
97+
98+
.sh_sourceCode .sh_ip {
99+
color: #006400;
100+
font-weight: normal;
101+
font-style: normal;
102+
}
103+
104+
.sh_sourceCode .sh_name {
105+
color: #006400;
106+
font-weight: normal;
107+
font-style: normal;
108+
}
109+
110+
.sh_sourceCode .sh_variable {
111+
color: #dda0dd;
112+
font-weight: bold;
113+
font-style: normal;
114+
}
115+
116+
.sh_sourceCode .sh_oldfile {
117+
color: #2e8b57;
118+
font-weight: normal;
119+
font-style: normal;
120+
}
121+
122+
.sh_sourceCode .sh_newfile {
123+
color: #006400;
124+
font-weight: normal;
125+
font-style: normal;
126+
}
127+
128+
.sh_sourceCode .sh_difflines {
129+
color: #000000;
130+
font-weight: bold;
131+
font-style: normal;
132+
}
133+
134+
.sh_sourceCode .sh_selector {
135+
color: #dda0dd;
136+
font-weight: bold;
137+
font-style: normal;
138+
}
139+
140+
.sh_sourceCode .sh_property {
141+
color: #000000;
142+
font-weight: bold;
143+
font-style: normal;
144+
}
145+
146+
.sh_sourceCode .sh_value {
147+
color: #006400;
148+
font-weight: normal;
149+
font-style: normal;
150+
}

‎Tools/jsdoc/cesium_template/static/styles/shCore.css

+226
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
/**
2+
* SyntaxHighlighter
3+
* http://alexgorbatchev.com/SyntaxHighlighter
4+
*
5+
* SyntaxHighlighter is donationware. If you are using it, please donate.
6+
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
7+
*
8+
* @version
9+
* 3.0.83 (July 02 2010)
10+
*
11+
* @copyright
12+
* Copyright (C) 2004-2010 Alex Gorbatchev.
13+
*
14+
* @license
15+
* Dual licensed under the MIT and GPL licenses.
16+
*/
17+
.syntaxhighlighter a,
18+
.syntaxhighlighter div,
19+
.syntaxhighlighter code,
20+
.syntaxhighlighter table,
21+
.syntaxhighlighter table td,
22+
.syntaxhighlighter table tr,
23+
.syntaxhighlighter table tbody,
24+
.syntaxhighlighter table thead,
25+
.syntaxhighlighter table caption,
26+
.syntaxhighlighter textarea {
27+
-moz-border-radius: 0 0 0 0 !important;
28+
-webkit-border-radius: 0 0 0 0 !important;
29+
background: none !important;
30+
border: 0 !important;
31+
bottom: auto !important;
32+
float: none !important;
33+
height: auto !important;
34+
left: auto !important;
35+
line-height: 1.1em !important;
36+
margin: 0 !important;
37+
outline: 0 !important;
38+
overflow: visible !important;
39+
padding: 0 !important;
40+
position: static !important;
41+
right: auto !important;
42+
text-align: left !important;
43+
top: auto !important;
44+
vertical-align: baseline !important;
45+
width: auto !important;
46+
box-sizing: content-box !important;
47+
font-family: "Consolas", "Bitstream Vera Sans Mono", "Courier New", Courier, monospace !important;
48+
font-weight: normal !important;
49+
font-style: normal !important;
50+
font-size: 1em !important;
51+
min-height: inherit !important;
52+
min-height: auto !important;
53+
}
54+
55+
.syntaxhighlighter {
56+
width: 100% !important;
57+
margin: 1em 0 1em 0 !important;
58+
position: relative !important;
59+
overflow: auto !important;
60+
font-size: 1em !important;
61+
}
62+
.syntaxhighlighter.source {
63+
overflow: hidden !important;
64+
}
65+
.syntaxhighlighter .bold {
66+
font-weight: bold !important;
67+
}
68+
.syntaxhighlighter .italic {
69+
font-style: italic !important;
70+
}
71+
.syntaxhighlighter .line {
72+
white-space: pre !important;
73+
}
74+
.syntaxhighlighter table {
75+
width: 100% !important;
76+
}
77+
.syntaxhighlighter table caption {
78+
text-align: left !important;
79+
padding: .5em 0 0.5em 1em !important;
80+
}
81+
.syntaxhighlighter table td.code {
82+
width: 100% !important;
83+
}
84+
.syntaxhighlighter table td.code .container {
85+
position: relative !important;
86+
}
87+
.syntaxhighlighter table td.code .container textarea {
88+
box-sizing: border-box !important;
89+
position: absolute !important;
90+
left: 0 !important;
91+
top: 0 !important;
92+
width: 100% !important;
93+
height: 100% !important;
94+
border: none !important;
95+
background: white !important;
96+
padding-left: 1em !important;
97+
overflow: hidden !important;
98+
white-space: pre !important;
99+
}
100+
.syntaxhighlighter table td.gutter .line {
101+
text-align: right !important;
102+
padding: 0 0.5em 0 1em !important;
103+
}
104+
.syntaxhighlighter table td.code .line {
105+
padding: 0 1em !important;
106+
}
107+
.syntaxhighlighter.nogutter td.code .container textarea, .syntaxhighlighter.nogutter td.code .line {
108+
padding-left: 0em !important;
109+
}
110+
.syntaxhighlighter.show {
111+
display: block !important;
112+
}
113+
.syntaxhighlighter.collapsed table {
114+
display: none !important;
115+
}
116+
.syntaxhighlighter.collapsed .toolbar {
117+
padding: 0.1em 0.8em 0em 0.8em !important;
118+
font-size: 1em !important;
119+
position: static !important;
120+
width: auto !important;
121+
height: auto !important;
122+
}
123+
.syntaxhighlighter.collapsed .toolbar span {
124+
display: inline !important;
125+
margin-right: 1em !important;
126+
}
127+
.syntaxhighlighter.collapsed .toolbar span a {
128+
padding: 0 !important;
129+
display: none !important;
130+
}
131+
.syntaxhighlighter.collapsed .toolbar span a.expandSource {
132+
display: inline !important;
133+
}
134+
.syntaxhighlighter .toolbar {
135+
position: absolute !important;
136+
right: 1px !important;
137+
top: 1px !important;
138+
width: 11px !important;
139+
height: 11px !important;
140+
font-size: 10px !important;
141+
z-index: 10 !important;
142+
}
143+
.syntaxhighlighter .toolbar span.title {
144+
display: inline !important;
145+
}
146+
.syntaxhighlighter .toolbar a {
147+
display: block !important;
148+
text-align: center !important;
149+
text-decoration: none !important;
150+
padding-top: 1px !important;
151+
}
152+
.syntaxhighlighter .toolbar a.expandSource {
153+
display: none !important;
154+
}
155+
.syntaxhighlighter.ie {
156+
font-size: .9em !important;
157+
padding: 1px 0 1px 0 !important;
158+
}
159+
.syntaxhighlighter.ie .toolbar {
160+
line-height: 8px !important;
161+
}
162+
.syntaxhighlighter.ie .toolbar a {
163+
padding-top: 0px !important;
164+
}
165+
.syntaxhighlighter.printing .line.alt1 .content,
166+
.syntaxhighlighter.printing .line.alt2 .content,
167+
.syntaxhighlighter.printing .line.highlighted .number,
168+
.syntaxhighlighter.printing .line.highlighted.alt1 .content,
169+
.syntaxhighlighter.printing .line.highlighted.alt2 .content {
170+
background: none !important;
171+
}
172+
.syntaxhighlighter.printing .line .number {
173+
color: #bbbbbb !important;
174+
}
175+
.syntaxhighlighter.printing .line .content {
176+
color: black !important;
177+
}
178+
.syntaxhighlighter.printing .toolbar {
179+
display: none !important;
180+
}
181+
.syntaxhighlighter.printing a {
182+
text-decoration: none !important;
183+
}
184+
.syntaxhighlighter.printing .plain, .syntaxhighlighter.printing .plain a {
185+
color: black !important;
186+
}
187+
.syntaxhighlighter.printing .comments, .syntaxhighlighter.printing .comments a {
188+
color: #008200 !important;
189+
}
190+
.syntaxhighlighter.printing .string, .syntaxhighlighter.printing .string a {
191+
color: blue !important;
192+
}
193+
.syntaxhighlighter.printing .keyword {
194+
color: #006699 !important;
195+
font-weight: bold !important;
196+
}
197+
.syntaxhighlighter.printing .preprocessor {
198+
color: gray !important;
199+
}
200+
.syntaxhighlighter.printing .variable {
201+
color: #aa7700 !important;
202+
}
203+
.syntaxhighlighter.printing .value {
204+
color: #009900 !important;
205+
}
206+
.syntaxhighlighter.printing .functions {
207+
color: #ff1493 !important;
208+
}
209+
.syntaxhighlighter.printing .constants {
210+
color: #0066cc !important;
211+
}
212+
.syntaxhighlighter.printing .script {
213+
font-weight: bold !important;
214+
}
215+
.syntaxhighlighter.printing .color1, .syntaxhighlighter.printing .color1 a {
216+
color: gray !important;
217+
}
218+
.syntaxhighlighter.printing .color2, .syntaxhighlighter.printing .color2 a {
219+
color: #ff1493 !important;
220+
}
221+
.syntaxhighlighter.printing .color3, .syntaxhighlighter.printing .color3 a {
222+
color: red !important;
223+
}
224+
.syntaxhighlighter.printing .break, .syntaxhighlighter.printing .break a {
225+
color: black !important;
226+
}

‎Tools/jsdoc/cesium_template/static/styles/shThemeDefault.css

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
/**
2+
* SyntaxHighlighter
3+
* http://alexgorbatchev.com/SyntaxHighlighter
4+
*
5+
* SyntaxHighlighter is donationware. If you are using it, please donate.
6+
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
7+
*
8+
* @version
9+
* 3.0.83 (July 02 2010)
10+
*
11+
* @copyright
12+
* Copyright (C) 2004-2010 Alex Gorbatchev.
13+
*
14+
* @license
15+
* Dual licensed under the MIT and GPL licenses.
16+
*/
17+
.syntaxhighlighter {
18+
background-color: white !important;
19+
}
20+
.syntaxhighlighter .line.alt1 {
21+
background-color: white !important;
22+
}
23+
.syntaxhighlighter .line.alt2 {
24+
background-color: white !important;
25+
}
26+
.syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
27+
background-color: #e0e0e0 !important;
28+
}
29+
.syntaxhighlighter .line.highlighted.number {
30+
color: black !important;
31+
}
32+
.syntaxhighlighter table caption {
33+
color: black !important;
34+
}
35+
.syntaxhighlighter .gutter {
36+
color: #afafaf !important;
37+
}
38+
.syntaxhighlighter .gutter .line {
39+
border-right: 3px solid #6ce26c !important;
40+
}
41+
.syntaxhighlighter .gutter .line.highlighted {
42+
background-color: #6ce26c !important;
43+
color: white !important;
44+
}
45+
.syntaxhighlighter.printing .line .content {
46+
border: none !important;
47+
}
48+
.syntaxhighlighter.collapsed {
49+
overflow: visible !important;
50+
}
51+
.syntaxhighlighter.collapsed .toolbar {
52+
color: blue !important;
53+
background: white !important;
54+
border: 1px solid #6ce26c !important;
55+
}
56+
.syntaxhighlighter.collapsed .toolbar a {
57+
color: blue !important;
58+
}
59+
.syntaxhighlighter.collapsed .toolbar a:hover {
60+
color: red !important;
61+
}
62+
.syntaxhighlighter .toolbar {
63+
color: white !important;
64+
background: #6ce26c !important;
65+
border: none !important;
66+
}
67+
.syntaxhighlighter .toolbar a {
68+
color: white !important;
69+
}
70+
.syntaxhighlighter .toolbar a:hover {
71+
color: black !important;
72+
}
73+
.syntaxhighlighter .plain, .syntaxhighlighter .plain a {
74+
color: black !important;
75+
}
76+
.syntaxhighlighter .comments, .syntaxhighlighter .comments a {
77+
color: #008200 !important;
78+
}
79+
.syntaxhighlighter .string, .syntaxhighlighter .string a {
80+
color: blue !important;
81+
}
82+
.syntaxhighlighter .keyword {
83+
color: #006699 !important;
84+
}
85+
.syntaxhighlighter .symbol {
86+
color: #E00000 !important;
87+
}
88+
.syntaxhighlighter .preprocessor {
89+
color: gray !important;
90+
}
91+
.syntaxhighlighter .variable {
92+
color: #aa7700 !important;
93+
}
94+
.syntaxhighlighter .value {
95+
color: #009900 !important;
96+
}
97+
.syntaxhighlighter .functions {
98+
color: #ff1493 !important;
99+
}
100+
.syntaxhighlighter .constants {
101+
color: #0066cc !important;
102+
}
103+
.syntaxhighlighter .script {
104+
font-weight: bold !important;
105+
color: #006699 !important;
106+
background-color: none !important;
107+
}
108+
.syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
109+
color: gray !important;
110+
}
111+
.syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
112+
color: #ff1493 !important;
113+
}
114+
.syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
115+
color: red !important;
116+
}
117+
118+
.syntaxhighlighter .keyword {
119+
font-weight: bold !important;
120+
}

‎Tools/jsdoc/cesium_template/tmpl/container.tmpl

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
<?js
2+
var self = this;
3+
docs.forEach(function(doc, i) {
4+
?>
5+
6+
<?js if (doc.kind === 'mainpage' || (doc.kind === 'package')) { ?>
7+
<?js= self.partial('mainpage.tmpl', doc) ?>
8+
<?js } else if (doc.kind === 'source') { ?>
9+
<?js= self.partial('source.tmpl', doc) ?>
10+
<?js } else { ?>
11+
12+
<section>
13+
14+
<header>
15+
<?js if (doc.classdesc) { ?>
16+
<div class="class-description"><?js= doc.classdesc ?></div>
17+
<?js } ?>
18+
</header>
19+
20+
<article>
21+
<div class="container-overview">
22+
<?js if (doc.kind === 'module' && doc.module) { ?>
23+
<?js= self.partial('method.tmpl', doc.module) ?>
24+
<?js } ?>
25+
26+
<?js if (doc.kind === 'class' || doc.kind === 'module') { ?>
27+
<?js= self.partial('method.tmpl', doc) ?>
28+
<?js } else { ?>
29+
<?js if (doc.description) { ?>
30+
<div class="description"><?js= doc.description ?></div>
31+
<?js } ?>
32+
33+
<?js= self.partial('details.tmpl', doc) ?>
34+
35+
<?js if (doc.examples && doc.examples.length) { ?>
36+
<h5>Example<?js= doc.examples.length > 1? 's':'' ?></h5>
37+
<?js= self.partial('examples.tmpl', doc.examples) ?>
38+
<?js } ?>
39+
<?js } ?>
40+
</div>
41+
42+
<?js if (doc.augments && doc.augments.length) { ?>
43+
<h3 class="subsection-title">Extends</h3>
44+
45+
<ul><?js doc.augments.forEach(function(a) { ?>
46+
<li><?js= self.linkto(a, a) ?></li>
47+
<?js }); ?></ul>
48+
<?js } ?>
49+
50+
<?js if (doc.mixes && doc.mixes.length) { ?>
51+
<h3 class="subsection-title">Mixes In</h3>
52+
53+
<ul><?js doc.mixes.forEach(function(a) { ?>
54+
<li><?js= self.linkto(a, a) ?></li>
55+
<?js }); ?></ul>
56+
<?js } ?>
57+
58+
<?js if (doc.requires && doc.requires.length) { ?>
59+
<h3 class="subsection-title">Requires</h3>
60+
61+
<ul><?js doc.requires.forEach(function(r) { ?>
62+
<li><?js= self.linkto(r, r) ?></li>
63+
<?js }); ?></ul>
64+
<?js } ?>
65+
66+
<?js
67+
var classes = self.find({kind: 'class', memberof: doc.longname});
68+
if (doc.kind !== 'globalobj' && classes && classes.length) {
69+
?>
70+
<h3 class="subsection-title">Classes</h3>
71+
72+
<dl><?js classes.forEach(function(c) { ?>
73+
<dt><?js= self.linkto(c.longname, c.name) ?></dt>
74+
<dd><?js if (c.summary) { ?><?js= c.summary ?><?js } ?></dd>
75+
<?js }); ?></dl>
76+
<?js } ?>
77+
78+
<?js
79+
var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
80+
if (doc.kind !== 'globalobj' && namespaces && namespaces.length) {
81+
?>
82+
<h3 class="subsection-title">Namespaces</h3>
83+
84+
<dl><?js namespaces.forEach(function(n) { ?>
85+
<dt><a href="namespaces.html#<?js= n.longname ?>"><?js= self.linkto(n.longname, n.name) ?></a></dt>
86+
<dd><?js if (n.summary) { ?><?js= n.summary ?><?js } ?></dd>
87+
<?js }); ?></dl>
88+
<?js } ?>
89+
90+
<?js
91+
var members = self.find({kind: 'member', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
92+
if (members && members.length && members.forEach) {
93+
?>
94+
<h3 class="subsection-title">Members</h3>
95+
96+
<dl><?js members.forEach(function(p) { ?>
97+
<?js= self.partial('members.tmpl', p) ?>
98+
<?js }); ?></dl>
99+
<?js } ?>
100+
101+
<?js
102+
var methods = self.find({kind: 'function', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
103+
if (methods && methods.length && methods.forEach) {
104+
?>
105+
<h3 class="subsection-title">Methods</h3>
106+
107+
<dl><?js methods.forEach(function(m) { ?>
108+
<?js= self.partial('method.tmpl', m) ?>
109+
<?js }); ?></dl>
110+
<?js } ?>
111+
112+
<?js
113+
var typedefs = self.find({kind: 'typedef', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
114+
if (typedefs && typedefs.length && typedefs.forEach) {
115+
?>
116+
<h3 class="subsection-title">Type Definitions</h3>
117+
118+
<dl><?js typedefs.forEach(function(e) {
119+
if (e.signature) {
120+
?>
121+
<?js= self.partial('method.tmpl', e) ?>
122+
<?js
123+
}
124+
else {
125+
?>
126+
<?js= self.partial('members.tmpl', e) ?>
127+
<?js
128+
}
129+
}); ?></dl>
130+
<?js } ?>
131+
132+
<?js
133+
var events = self.find({kind: 'event', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
134+
if (events && events.length && events.forEach) {
135+
?>
136+
<h3 class="subsection-title">Events</h3>
137+
138+
<dl><?js events.forEach(function(e) { ?>
139+
<?js= self.partial('method.tmpl', e) ?>
140+
<?js }); ?></dl>
141+
<?js } ?>
142+
</article>
143+
144+
</section>
145+
<?js } ?>
146+
147+
<?js }); ?>

‎Tools/jsdoc/cesium_template/tmpl/details.tmpl

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
var defaultObjectClass = '';
5+
6+
// Check if the default value is an object or array; if so, apply code highlighting
7+
if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
8+
data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
9+
defaultObjectClass = ' class="object-value"';
10+
}
11+
?>
12+
<dl class="details">
13+
<?js
14+
var properties = data.properties;
15+
if (properties && properties.length && properties.forEach) {
16+
?>
17+
18+
<h5 class="subsection-title">Properties:</h5>
19+
20+
<dl><?js= this.partial('properties.tmpl', properties) ?></dl>
21+
22+
<?js } ?>
23+
24+
<?js if (data.version) {?>
25+
<dt class="tag-version">Version:</dt>
26+
<dd class="tag-version"><ul class="dummy"><li><?js= version ?></li></ul></dd>
27+
<?js } ?>
28+
29+
<?js if (data.since) {?>
30+
<dt class="tag-since">Since:</dt>
31+
<dd class="tag-since"><ul class="dummy"><li><?js= since ?></dd>
32+
<?js } ?>
33+
34+
<?js if (data.inherited && data.inherits) { ?>
35+
<dt class="inherited-from">Inherited From:</dt>
36+
<dd class="inherited-from"><ul class="dummy"><li>
37+
<?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
38+
</li></dd>
39+
<?js } ?>
40+
41+
<?js if (data.deprecated) { ?>
42+
<dt class="important tag-deprecated">Deprecated:</dt><?js
43+
if (data.deprecated === true) { ?><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><?js }
44+
else { ?><dd><ul class="dummy"><li><?js= data.deprecated ?></li><ul></dd><?js }
45+
?>
46+
<?js } ?>
47+
48+
<?js if (data.author && author.length) {?>
49+
<dt class="tag-author">Author:</dt>
50+
<dd class="tag-author">
51+
<ul><?js author.forEach(function(a) { ?>
52+
<li><?js= self.resolveAuthorLinks(a) ?></li>
53+
<?js }); ?></ul>
54+
</dd>
55+
<?js } ?>
56+
57+
<?js if (data.copyright) {?>
58+
<dt class="tag-copyright">Copyright:</dt>
59+
<dd class="tag-copyright"><ul class="dummy"><li><?js= copyright ?></li></ul></dd>
60+
<?js } ?>
61+
62+
<?js if (data.license) {?>
63+
<dt class="tag-license">License:</dt>
64+
<dd class="tag-license"><ul class="dummy"><li><?js= license ?></li></ul></dd>
65+
<?js } ?>
66+
67+
<?js if (data.defaultvalue) {?>
68+
<h5>Default Value:</h5>
69+
<div<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></div>
70+
<?js } ?>
71+
72+
<?js if (data.meta && self.outputSourceFiles) {?>
73+
<dt class="tag-source">Source:</dt>
74+
<dd class="tag-source"><ul class="dummy"><li>
75+
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
76+
</li></ul></dd>
77+
<?js } ?>
78+
79+
<?js if (data.tutorials && tutorials.length) {?>
80+
<dt class="tag-tutorial">Tutorials:</dt>
81+
<dd class="tag-tutorial">
82+
<ul><?js tutorials.forEach(function(t) { ?>
83+
<li><?js= self.tutoriallink(t) ?></li>
84+
<?js }); ?></ul>
85+
</dd>
86+
<?js } ?>
87+
88+
<?js if (data.demo && demo.length) { ?>
89+
<h5>Demo:</h5>
90+
<ul class="see-list"><?js demo.forEach(function(d) { ?>
91+
<li><?js= d ?></li>
92+
<?js }); ?></ul>
93+
<?js } ?>
94+
95+
<?js if (data.see && see.length) {?>
96+
<h5>See:</h5>
97+
<ul class="see-list"><?js see.forEach(function(s) { ?>
98+
<li><?js= self.linkto(s) ?></li>
99+
<?js }); ?></ul>
100+
<?js } ?>
101+
102+
<?js if (data.todo && todo.length) {?>
103+
<dt class="tag-todo">To Do:</dt>
104+
<dd class="tag-todo">
105+
<ul><?js todo.forEach(function(t) { ?>
106+
<li><?js= t ?></li>
107+
<?js }); ?></ul>
108+
</dd>
109+
<?js } ?>
110+
</dl>

‎Tools/jsdoc/cesium_template/tmpl/example.tmpl

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?js var data = obj; ?>
2+
<pre><code><?js= data ?></code></pre>

‎Tools/jsdoc/cesium_template/tmpl/examples.tmpl

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
5+
data.forEach(function(example) {
6+
if (example.caption) {
7+
?>
8+
<p class="code-caption"><?js= example.caption ?></p>
9+
<?js } ?>
10+
<pre class="code brush: js"><?js= self.htmlsafe(example.code) ?></pre>
11+
<?js
12+
});
13+
?>

‎Tools/jsdoc/cesium_template/tmpl/exceptions.tmpl

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?js
2+
var data = obj;
3+
?>
4+
<?js if (data.description && data.type && data.type.names) { ?>
5+
<div class="param-desc">
6+
<?js= this.partial('type.tmpl', data.type.names) ?>: <?js= data.description ?>
7+
</div>
8+
<?js } else { ?>
9+
<div class="param-desc">
10+
<?js if (data.description) { ?>
11+
<?js= data.description ?>
12+
<?js } else if (data.type && data.type.names) { ?>
13+
<?js= this.partial('type.tmpl', data.type.names) ?>
14+
<?js } ?>
15+
</div>
16+
<?js } ?>

‎Tools/jsdoc/cesium_template/tmpl/indexLayout.tmpl

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
6+
<title><?js= (title ? (title + ' - ') : '') + 'Cesium Documentation' ?></title>
7+
8+
<!--[if lt IE 9]>
9+
<script src="javascript/html5.js"></script>
10+
<![endif]-->
11+
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
12+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
13+
14+
<link rel="stylesheet" href="styles/shCore.css" media="all"></link>
15+
<link rel="stylesheet" href="styles/shThemeDefault.css" media="all"></link>
16+
<script src="javascript/shCore.js"></script>
17+
<script src="javascript/shBrushJScript.js"></script>
18+
</head>
19+
<body>
20+
21+
<div id="bkgd">
22+
23+
<div id="mainIndex">
24+
25+
<div class="nav">
26+
<div class="menu">
27+
<a href="http://cesiumjs.org/"><img id="cesium-logo" src="images/CesiumLogo.jpg" class="hide"></a>
28+
<div class="divider"></div>
29+
30+
<input type="text" class="classFilter" id="ClassFilter" placeholder="Filter">
31+
32+
<?js= this.nav ?>
33+
</div>
34+
</div>
35+
36+
<?js= content ?>
37+
38+
<footer>
39+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a>
40+
</footer>
41+
</div>
42+
43+
</div>
44+
45+
<br clear="both">
46+
47+
<script>
48+
if (!window.frameElement) {
49+
document.getElementById('bkgd').className = "show-bkgd";
50+
document.getElementById('cesium-logo').className = "indexLogo";
51+
}
52+
53+
document.getElementById('ClassFilter').focus();
54+
</script>
55+
56+
<script src="javascript/cesiumDoc.js"></script>
57+
58+
</body>
59+
</html>

‎Tools/jsdoc/cesium_template/tmpl/layout.tmpl

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
6+
<title><?js= (title ? (title + ' - ') : '') + 'Cesium Documentation' ?></title>
7+
8+
<!--[if lt IE 9]>
9+
<script src="javascript/html5.js"></script>
10+
<![endif]-->
11+
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
12+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
13+
14+
<link rel="stylesheet" href="styles/shCore.css" media="all"></link>
15+
<link rel="stylesheet" href="styles/shThemeDefault.css" media="all"></link>
16+
<script src="javascript/shCore.js"></script>
17+
<script src="javascript/shBrushJScript.js"></script>
18+
</head>
19+
<body>
20+
21+
<div id="bkgd">
22+
23+
<div class="nav">
24+
<div class="menu">
25+
<a href="index.html"><img id="cesium-logo" src="images/CesiumLogo.jpg" class="menuLogo"></a>
26+
<div class="divider"></div>
27+
28+
<input type="text" class="classFilter" id="ClassFilter" placeholder="Filter">
29+
30+
<?js= this.nav ?>
31+
</div>
32+
</div>
33+
34+
<div class="nav navStatic"></div>
35+
36+
<div id="main">
37+
38+
<h1 class="page-title"><?js= title ?></h1>
39+
40+
<?js= content ?>
41+
42+
<footer>
43+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a>
44+
</footer>
45+
</div>
46+
47+
</div>
48+
49+
<br clear="both">
50+
51+
<script>
52+
if (window.frameElement) {
53+
document.body.className = 'embedded';
54+
55+
var ele = document.createElement('a');
56+
ele.className = 'popout';
57+
ele.target = '_blank';
58+
ele.href = window.location.href;
59+
ele.title = 'Pop out';
60+
document.getElementById('main').appendChild(ele);
61+
62+
ele = document.createElement('a');
63+
ele.className = 'back';
64+
ele.href = 'index.html';
65+
ele.title = 'Home';
66+
ele.target = '_self';
67+
document.getElementById('main').appendChild(ele);
68+
} else {
69+
document.getElementById('bkgd').className = 'show-bkgd';
70+
}
71+
</script>
72+
73+
<script src="javascript/cesiumDoc.js"></script>
74+
75+
</body>
76+
</html>

‎Tools/jsdoc/cesium_template/tmpl/mainpage.tmpl

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
?>
5+
6+
<?js if (data.kind === 'package') { ?>
7+
<h3><?js= data.name ?> <?js= data.version ?></h3>
8+
<?js } ?>
9+
10+
<?js if (data.readme) { ?>
11+
<section>
12+
<article><?js= data.readme ?></article>
13+
</section>
14+
<?js } ?>

‎Tools/jsdoc/cesium_template/tmpl/members.tmpl

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
?>
5+
<dt>
6+
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + (data.scope === 'static' ? longname : name) + (data.signature ? data.signature : '') ?></h4>
7+
8+
<?js if (data.summary) { ?>
9+
<p class="summary"><?js= summary ?></p>
10+
<?js } ?>
11+
</dt>
12+
<dd>
13+
<?js if (data.description) { ?>
14+
<div class="description">
15+
<?js= data.description ?>
16+
</div>
17+
<?js } ?>
18+
19+
<?js= this.partial('details.tmpl', data) ?>
20+
21+
<?js if (data.fires && fires.length) { ?>
22+
<h5>Fires:</h5>
23+
<ul><?js fires.forEach(function(f) { ?>
24+
<li><?js= self.linkto(f) ?></li>
25+
<?js }); ?></ul>
26+
<?js } ?>
27+
28+
<?js if (data.examples && examples.length) { ?>
29+
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
30+
<?js= this.partial('examples.tmpl', examples) ?>
31+
<?js } ?>
32+
</dd>

‎Tools/jsdoc/cesium_template/tmpl/method.tmpl

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
?>
5+
<dt>
6+
<h4 class="name" id="<?js= id ?>">
7+
<?js= data.attribs + (kind === 'class' ? 'new ' : '') + (data.scope === 'static' ? longname : name) + (data.signature ? data.signature : '') ?>
8+
</h4>
9+
10+
<?js if (data.summary) { ?>
11+
<p class="summary"><?js= summary ?></p>
12+
<?js } ?>
13+
</dt>
14+
<dd>
15+
16+
<?js if (data.description) { ?>
17+
<div class="description">
18+
<?js= data.description ?>
19+
</div>
20+
<?js } ?>
21+
22+
<?js if (data.performance) { ?>
23+
<h5>Performance:</h5>
24+
<p class="description"><?js= data.performance ?></p>
25+
<?js } ?>
26+
27+
<?js if (kind === 'event' && data.type && data.type.names) {?>
28+
<h5>Type:</h5>
29+
<ul>
30+
<li>
31+
<?js= self.partial('type.tmpl', data.type.names) ?>
32+
</li>
33+
</ul>
34+
<?js } ?>
35+
36+
<?js if (data['this']) { ?>
37+
<h5>This:</h5>
38+
<ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
39+
<?js } ?>
40+
41+
<?js if (data.params && params.length) { ?>
42+
<?js= this.partial('params.tmpl', params) ?>
43+
<?js } ?>
44+
45+
<?js= this.partial('details.tmpl', data) ?>
46+
47+
<?js if (data.requires && data.requires.length) { ?>
48+
<h5>Requires:</h5>
49+
<ul><?js data.requires.forEach(function(r) { ?>
50+
<li><?js= self.linkto(r) ?></li>
51+
<?js }); ?></ul>
52+
<?js } ?>
53+
54+
<?js if (data.fires && fires.length) { ?>
55+
<h5>Fires:</h5>
56+
<ul><?js fires.forEach(function(f) { ?>
57+
<li><?js= self.linkto(f) ?></li>
58+
<?js }); ?></ul>
59+
<?js } ?>
60+
61+
<?js if (data.listens && listens.length) { ?>
62+
<h5>Listens to Events:</h5>
63+
<ul><?js listens.forEach(function(f) { ?>
64+
<li><?js= self.linkto(f) ?></li>
65+
<?js }); ?></ul>
66+
<?js } ?>
67+
68+
<?js if (data.listeners && listeners.length) { ?>
69+
<h5>Listeners of This Event:</h5>
70+
<ul><?js listeners.forEach(function(f) { ?>
71+
<li><?js= self.linkto(f) ?></li>
72+
<?js }); ?></ul>
73+
<?js } ?>
74+
75+
<?js if (data.exceptions && exceptions.length) { ?>
76+
<h5>Throws:</h5>
77+
<ul><?js
78+
exceptions.forEach(function(r) { ?>
79+
<li><?js= self.partial('exceptions.tmpl', r) ?></li>
80+
<?js });
81+
?></ul>
82+
<?js } ?>
83+
84+
<?js if (data.returns && returns.length) { ?>
85+
<h5>Returns:</h5>
86+
<?js if (returns.length > 1) { ?><ul><?js
87+
returns.forEach(function(r) { ?>
88+
<li><?js= self.partial('returns.tmpl', r) ?></li>
89+
<?js });
90+
?></ul><?js } else {
91+
returns.forEach(function(r) { ?>
92+
<?js= self.partial('returns.tmpl', r) ?>
93+
<?js });
94+
} } ?>
95+
96+
<?js if (data.examples && examples.length) { ?>
97+
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
98+
<?js= this.partial('examples.tmpl', examples) ?>
99+
<?js } ?>
100+
</dd>

‎Tools/jsdoc/cesium_template/tmpl/params.tmpl

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<?js
2+
var params = obj;
3+
4+
/* sort subparams under their parent params (like opts.classname) */
5+
var parentParam = null;
6+
params.forEach(function(param, i) {
7+
if (!param) { return; }
8+
if ( parentParam && param.name && param.name.indexOf(parentParam.name + '.') === 0 ) {
9+
param.name = param.name.substr(parentParam.name.length+1);
10+
parentParam.subparams = parentParam.subparams || [];
11+
parentParam.subparams.push(param);
12+
params[i] = null;
13+
}
14+
else {
15+
parentParam = param;
16+
}
17+
});
18+
19+
/* determine if we need extra columns, "attributes" and "default" */
20+
params.hasAttributes = false;
21+
params.hasDefault = false;
22+
params.hasName = false;
23+
24+
params.forEach(function(param) {
25+
if (!param) { return; }
26+
27+
if (param.optional || param.nullable || param.variable) {
28+
params.hasAttributes = true;
29+
}
30+
31+
if (param.name) {
32+
params.hasName = true;
33+
}
34+
35+
if (typeof param.defaultvalue !== 'undefined') {
36+
params.hasDefault = true;
37+
}
38+
});
39+
?>
40+
41+
<table class="params">
42+
<thead>
43+
<tr>
44+
<?js if (params.hasName) {?>
45+
<th>Name</th>
46+
<?js } ?>
47+
48+
<th>Type</th>
49+
50+
<?js if (params.hasDefault) {?>
51+
<th>Default</th>
52+
<?js } ?>
53+
54+
<th class="last">Description</th>
55+
</tr>
56+
</thead>
57+
58+
<tbody>
59+
<?js
60+
var self = this;
61+
params.forEach(function(param) {
62+
if (!param) { return; }
63+
?>
64+
65+
<tr>
66+
<?js if (params.hasName) {?>
67+
<td class="name"><code><?js= param.name ?></code></td>
68+
<?js } ?>
69+
70+
<td class="type">
71+
<?js if (param.type && param.type.names) {?>
72+
<?js= self.partial('type.tmpl', param.type.names) ?>
73+
<?js } ?>
74+
</td>
75+
76+
<?js if (params.hasDefault) {?>
77+
<td class="default">
78+
<?js if (typeof param.defaultvalue !== 'undefined') { ?>
79+
<?js= self.htmlsafe(param.defaultvalue) ?>
80+
<?js } ?>
81+
</td>
82+
<?js } ?>
83+
84+
<td class="description last">
85+
<?js if (params.hasAttributes) {?>
86+
<?js if (param.optional) { ?>
87+
<span class="optional">optional</span>
88+
<?js } ?>
89+
<?js if (param.nullable) { ?>
90+
<span class="nullable">nullable</span>
91+
<?js } ?>
92+
93+
<?js if (param.variable) { ?>
94+
<span class="repeatable">repeatable</span>
95+
<?js } ?>
96+
<?js } ?>
97+
<?js= param.description ?><?js if (param.subparams) { ?>
98+
<?js= self.partial('params.tmpl', param.subparams) ?>
99+
<?js } ?></td>
100+
</tr>
101+
102+
<?js }); ?>
103+
</tbody>
104+
</table>

‎Tools/jsdoc/cesium_template/tmpl/properties.tmpl

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?js
2+
var props = obj;
3+
4+
/* sort subprops under their parent props (like opts.classname) */
5+
var parentProp = null;
6+
props.forEach(function(prop, i) {
7+
if (!prop) { return; }
8+
if ( parentProp && prop.name && prop.name.indexOf(parentProp.name + '.') === 0 ) {
9+
prop.name = prop.name.substr(parentProp.name.length+1);
10+
parentProp.subprops = parentProp.subprops || [];
11+
parentProp.subprops.push(prop);
12+
props[i] = null;
13+
}
14+
else {
15+
parentProp = prop;
16+
}
17+
});
18+
19+
/* determine if we need extra columns, "attributes" and "default" */
20+
props.hasAttributes = false;
21+
props.hasDefault = false;
22+
props.hasName = false;
23+
24+
props.forEach(function(prop) {
25+
if (!prop) { return; }
26+
27+
if (prop.optional || prop.nullable) {
28+
props.hasAttributes = true;
29+
}
30+
31+
if (prop.name) {
32+
props.hasName = true;
33+
}
34+
35+
if (typeof prop.defaultvalue !== 'undefined') {
36+
props.hasDefault = true;
37+
}
38+
});
39+
?>
40+
41+
<table class="props">
42+
<thead>
43+
<tr>
44+
<?js if (props.hasName) {?>
45+
<th>Name</th>
46+
<?js } ?>
47+
48+
<th>Type</th>
49+
50+
<?js if (props.hasAttributes) {?>
51+
<th>Attributes</th>
52+
<?js } ?>
53+
54+
<?js if (props.hasDefault) {?>
55+
<th>Default</th>
56+
<?js } ?>
57+
58+
<th class="last">Description</th>
59+
</tr>
60+
</thead>
61+
62+
<tbody>
63+
<?js
64+
var self = this;
65+
props.forEach(function(prop) {
66+
if (!prop) { return; }
67+
?>
68+
69+
<tr>
70+
<?js if (props.hasName) {?>
71+
<td class="name"><code><?js= prop.name ?></code></td>
72+
<?js } ?>
73+
74+
<td class="type">
75+
<?js if (prop.type && prop.type.names) {?>
76+
<?js= self.partial('type.tmpl', prop.type.names) ?>
77+
<?js } ?>
78+
</td>
79+
80+
<?js if (props.hasAttributes) {?>
81+
<td class="attributes">
82+
<?js if (prop.optional) { ?>
83+
&lt;optional><br>
84+
<?js } ?>
85+
86+
<?js if (prop.nullable) { ?>
87+
&lt;nullable><br>
88+
<?js } ?>
89+
</td>
90+
<?js } ?>
91+
92+
<?js if (props.hasDefault) {?>
93+
<td class="default">
94+
<?js if (typeof prop.defaultvalue !== 'undefined') { ?>
95+
<?js= self.htmlsafe(prop.defaultvalue) ?>
96+
<?js } ?>
97+
</td>
98+
<?js } ?>
99+
100+
<td class="description last"><?js= prop.description ?><?js if (prop.subprops) { ?>
101+
<h6>Properties</h6><?js= self.partial('properties.tmpl', prop.subprops) ?>
102+
<?js } ?></td>
103+
</tr>
104+
105+
<?js }); ?>
106+
</tbody>
107+
</table>

‎Tools/jsdoc/cesium_template/tmpl/returns.tmpl

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?js
2+
var data = obj || {};
3+
if (data.description) {
4+
?>
5+
<div class="param-desc">
6+
<?js= description ?>
7+
</div>
8+
<?js } ?>

‎Tools/jsdoc/cesium_template/tmpl/source.tmpl

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?js
2+
var data = obj;
3+
?>
4+
<section>
5+
<article>
6+
<pre class="prettyprint source linenums"><code><?js= data.code ?></code></pre>
7+
</article>
8+
</section>

‎Tools/jsdoc/cesium_template/tmpl/tutorial.tmpl

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<section>
2+
3+
<header>
4+
<?js if (children.length > 0) { ?>
5+
<ul><?js
6+
var self = this;
7+
children.forEach(function(t) { ?>
8+
<li><?js= self.tutoriallink(t.name) ?></li>
9+
<?js }); ?></ul>
10+
<?js } ?>
11+
12+
<h2><?js= header ?></h2>
13+
</header>
14+
15+
<article>
16+
<?js= content ?>
17+
</article>
18+
19+
</section>

‎Tools/jsdoc/cesium_template/tmpl/type.tmpl

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?js
2+
var data = obj;
3+
var self = this;
4+
data.forEach(function(name, i) { ?>
5+
<span class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></span>
6+
<?js if (i < data.length-1) { ?>|<?js } ?>
7+
<?js }); ?>

‎Tools/jsdoc/conf.json

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"tags": {
3+
"allowUnknownTags": false
4+
},
5+
"source": {
6+
"include": ["Source"],
7+
"exclude": ["Source/ThirdParty", "Source/Workers/cesiumWorkerBootstrapper.js"],
8+
"includePattern": ".+\\.js(doc)?$",
9+
"excludePattern": "(^|\\/|\\\\)_"
10+
},
11+
"plugins": ["cesiumTags"],
12+
"templates": {
13+
"cleverLinks": true,
14+
"cesium_template": {
15+
"outputSourceFiles": false
16+
}
17+
},
18+
"opts": {
19+
"destination": "Build/DocumentationNew",
20+
"recurse": true
21+
}
22+
}

‎package.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "cesium",
3+
"version": "0.28.0",
4+
"description": "Cesium is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.",
5+
"homepage": "http://cesiumjs.org",
6+
"license": "Apache-2.0",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/AnalyticalGraphicsInc/cesium.git"
10+
},
11+
"devDependencies": {
12+
"jsdoc": "3.3.0-alpha5"
13+
}
14+
}

0 commit comments

Comments
 (0)
Please sign in to comment.