jsdoc-rails 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (213) hide show
  1. data/.gitignore +8 -0
  2. data/Gemfile +5 -0
  3. data/MIT-LICENSE +20 -0
  4. data/README.rdoc +94 -0
  5. data/Rakefile +29 -0
  6. data/app/controllers/jsdoc/documentation_controller.rb +48 -0
  7. data/app/helpers/jsdoc/documentation_helper.rb +50 -0
  8. data/app/models/jsdoc/borrowed_function.rb +7 -0
  9. data/app/models/jsdoc/borrowed_property.rb +7 -0
  10. data/app/models/jsdoc/example.rb +5 -0
  11. data/app/models/jsdoc/function.rb +21 -0
  12. data/app/models/jsdoc/param.rb +7 -0
  13. data/app/models/jsdoc/property.rb +13 -0
  14. data/app/models/jsdoc/require.rb +5 -0
  15. data/app/models/jsdoc/return.rb +5 -0
  16. data/app/models/jsdoc/see.rb +4 -0
  17. data/app/models/jsdoc/symbol.rb +58 -0
  18. data/app/models/jsdoc/throw.rb +4 -0
  19. data/app/views/jsdoc/documentation/_inheritance_tree_branch.html.erb +12 -0
  20. data/app/views/jsdoc/documentation/_members_table.html.erb +38 -0
  21. data/app/views/jsdoc/documentation/_param_list.html.erb +11 -0
  22. data/app/views/jsdoc/documentation/index.html.erb +7 -0
  23. data/app/views/jsdoc/documentation/source.html.erb +11 -0
  24. data/app/views/jsdoc/documentation/symbol.html.erb +111 -0
  25. data/app/views/layouts/jsdoc/_aside_symbol_list.html.erb +12 -0
  26. data/app/views/layouts/jsdoc/_header.html.erb +1 -0
  27. data/app/views/layouts/jsdoc/_symbol_tree_branch.html.erb +3 -0
  28. data/app/views/layouts/jsdoc/documentation.html.erb +44 -0
  29. data/app/views/layouts/jsdoc/documentation_wrapper.html.erb +2 -0
  30. data/config/routes.rb +8 -0
  31. data/jsdoc-rails.gemspec +25 -0
  32. data/jsdoc-toolkit/README.txt +183 -0
  33. data/jsdoc-toolkit/app/frame.js +33 -0
  34. data/jsdoc-toolkit/app/frame/Chain.js +102 -0
  35. data/jsdoc-toolkit/app/frame/Dumper.js +144 -0
  36. data/jsdoc-toolkit/app/frame/Hash.js +84 -0
  37. data/jsdoc-toolkit/app/frame/Link.js +173 -0
  38. data/jsdoc-toolkit/app/frame/Namespace.js +10 -0
  39. data/jsdoc-toolkit/app/frame/Opt.js +134 -0
  40. data/jsdoc-toolkit/app/frame/Reflection.js +26 -0
  41. data/jsdoc-toolkit/app/frame/String.js +93 -0
  42. data/jsdoc-toolkit/app/frame/Testrun.js +129 -0
  43. data/jsdoc-toolkit/app/handlers/FOODOC.js +26 -0
  44. data/jsdoc-toolkit/app/handlers/XMLDOC.js +26 -0
  45. data/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js +159 -0
  46. data/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js +16 -0
  47. data/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js +292 -0
  48. data/jsdoc-toolkit/app/lib/JSDOC.js +106 -0
  49. data/jsdoc-toolkit/app/lib/JSDOC/DocComment.js +204 -0
  50. data/jsdoc-toolkit/app/lib/JSDOC/DocTag.js +294 -0
  51. data/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js +140 -0
  52. data/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js +109 -0
  53. data/jsdoc-toolkit/app/lib/JSDOC/Lang.js +144 -0
  54. data/jsdoc-toolkit/app/lib/JSDOC/Parser.js +146 -0
  55. data/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js +33 -0
  56. data/jsdoc-toolkit/app/lib/JSDOC/Symbol.js +646 -0
  57. data/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js +243 -0
  58. data/jsdoc-toolkit/app/lib/JSDOC/TextStream.js +41 -0
  59. data/jsdoc-toolkit/app/lib/JSDOC/Token.js +18 -0
  60. data/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js +332 -0
  61. data/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js +133 -0
  62. data/jsdoc-toolkit/app/lib/JSDOC/Util.js +32 -0
  63. data/jsdoc-toolkit/app/lib/JSDOC/Walker.js +557 -0
  64. data/jsdoc-toolkit/app/main.js +111 -0
  65. data/jsdoc-toolkit/app/plugins/commentSrcJson.js +20 -0
  66. data/jsdoc-toolkit/app/plugins/frameworkPrototype.js +16 -0
  67. data/jsdoc-toolkit/app/plugins/functionCall.js +10 -0
  68. data/jsdoc-toolkit/app/plugins/publishSrcHilite.js +62 -0
  69. data/jsdoc-toolkit/app/plugins/symbolLink.js +10 -0
  70. data/jsdoc-toolkit/app/plugins/tagParamConfig.js +31 -0
  71. data/jsdoc-toolkit/app/plugins/tagSynonyms.js +45 -0
  72. data/jsdoc-toolkit/app/run.js +348 -0
  73. data/jsdoc-toolkit/app/t/TestDoc.js +144 -0
  74. data/jsdoc-toolkit/app/t/runner.js +13 -0
  75. data/jsdoc-toolkit/app/test.js +342 -0
  76. data/jsdoc-toolkit/app/test/addon.js +24 -0
  77. data/jsdoc-toolkit/app/test/anon_inner.js +14 -0
  78. data/jsdoc-toolkit/app/test/augments.js +31 -0
  79. data/jsdoc-toolkit/app/test/augments2.js +26 -0
  80. data/jsdoc-toolkit/app/test/borrows.js +46 -0
  81. data/jsdoc-toolkit/app/test/borrows2.js +23 -0
  82. data/jsdoc-toolkit/app/test/config.js +22 -0
  83. data/jsdoc-toolkit/app/test/constructs.js +18 -0
  84. data/jsdoc-toolkit/app/test/encoding.js +10 -0
  85. data/jsdoc-toolkit/app/test/encoding_other.js +12 -0
  86. data/jsdoc-toolkit/app/test/event.js +54 -0
  87. data/jsdoc-toolkit/app/test/exports.js +14 -0
  88. data/jsdoc-toolkit/app/test/functions_anon.js +39 -0
  89. data/jsdoc-toolkit/app/test/functions_nested.js +33 -0
  90. data/jsdoc-toolkit/app/test/global.js +13 -0
  91. data/jsdoc-toolkit/app/test/globals.js +25 -0
  92. data/jsdoc-toolkit/app/test/ignore.js +10 -0
  93. data/jsdoc-toolkit/app/test/inner.js +16 -0
  94. data/jsdoc-toolkit/app/test/jsdoc_test.js +477 -0
  95. data/jsdoc-toolkit/app/test/lend.js +33 -0
  96. data/jsdoc-toolkit/app/test/memberof.js +19 -0
  97. data/jsdoc-toolkit/app/test/memberof2.js +38 -0
  98. data/jsdoc-toolkit/app/test/memberof3.js +33 -0
  99. data/jsdoc-toolkit/app/test/memberof_constructor.js +17 -0
  100. data/jsdoc-toolkit/app/test/module.js +17 -0
  101. data/jsdoc-toolkit/app/test/multi_methods.js +25 -0
  102. data/jsdoc-toolkit/app/test/name.js +19 -0
  103. data/jsdoc-toolkit/app/test/namespace_nested.js +23 -0
  104. data/jsdoc-toolkit/app/test/nocode.js +13 -0
  105. data/jsdoc-toolkit/app/test/oblit_anon.js +20 -0
  106. data/jsdoc-toolkit/app/test/overview.js +20 -0
  107. data/jsdoc-toolkit/app/test/param_inline.js +37 -0
  108. data/jsdoc-toolkit/app/test/params_optional.js +8 -0
  109. data/jsdoc-toolkit/app/test/prototype.js +17 -0
  110. data/jsdoc-toolkit/app/test/prototype_nested.js +9 -0
  111. data/jsdoc-toolkit/app/test/prototype_oblit.js +13 -0
  112. data/jsdoc-toolkit/app/test/prototype_oblit_constructor.js +24 -0
  113. data/jsdoc-toolkit/app/test/public.js +10 -0
  114. data/jsdoc-toolkit/app/test/scripts/code.js +5 -0
  115. data/jsdoc-toolkit/app/test/scripts/notcode.txt +5 -0
  116. data/jsdoc-toolkit/app/test/shared.js +42 -0
  117. data/jsdoc-toolkit/app/test/shared2.js +2 -0
  118. data/jsdoc-toolkit/app/test/shortcuts.js +22 -0
  119. data/jsdoc-toolkit/app/test/static_this.js +13 -0
  120. data/jsdoc-toolkit/app/test/synonyms.js +31 -0
  121. data/jsdoc-toolkit/app/test/tosource.js +23 -0
  122. data/jsdoc-toolkit/app/test/variable_redefine.js +14 -0
  123. data/jsdoc-toolkit/changes.txt +124 -0
  124. data/jsdoc-toolkit/conf/sample.conf +31 -0
  125. data/jsdoc-toolkit/java/build.xml +36 -0
  126. data/jsdoc-toolkit/java/build_1.4.xml +36 -0
  127. data/jsdoc-toolkit/java/classes/js.jar +0 -0
  128. data/jsdoc-toolkit/java/src/JsDebugRun.java +21 -0
  129. data/jsdoc-toolkit/java/src/JsRun.java +21 -0
  130. data/jsdoc-toolkit/jsdebug.jar +0 -0
  131. data/jsdoc-toolkit/jsrun.jar +0 -0
  132. data/jsdoc-toolkit/jsrun.sh +52 -0
  133. data/jsdoc-toolkit/templates/jsdoc-rails/publish.js +202 -0
  134. data/jsdoc-toolkit/templates/jsdoc-rails/seeds.tmpl +449 -0
  135. data/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl +17 -0
  136. data/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +56 -0
  137. data/jsdoc-toolkit/templates/jsdoc/class.tmpl +649 -0
  138. data/jsdoc-toolkit/templates/jsdoc/index.tmpl +39 -0
  139. data/jsdoc-toolkit/templates/jsdoc/publish.js +201 -0
  140. data/jsdoc-toolkit/templates/jsdoc/static/default.css +162 -0
  141. data/jsdoc-toolkit/templates/jsdoc/static/header.html +2 -0
  142. data/jsdoc-toolkit/templates/jsdoc/static/index.html +19 -0
  143. data/jsdoc-toolkit/templates/jsdoc/symbol.tmpl +35 -0
  144. data/lib/generators/jsdoc/jsdoc_generator.rb +71 -0
  145. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_borrowed_functions_table.rb +19 -0
  146. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_borrowed_properties_table.rb +19 -0
  147. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_examples_table.rb +18 -0
  148. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_functions_table.rb +33 -0
  149. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_params_table.rb +24 -0
  150. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_properties_table.rb +37 -0
  151. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_requires_table.rb +16 -0
  152. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_returns_table.rb +18 -0
  153. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_sees_table.rb +18 -0
  154. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_symbols_table.rb +31 -0
  155. data/lib/generators/jsdoc/templates/migrations/jsdoc_create_throws_table.rb +18 -0
  156. data/lib/jsdoc.rb +3 -0
  157. data/lib/jsdoc/engine.rb +30 -0
  158. data/lib/jsdoc/railties/tasks.rake +89 -0
  159. data/lib/jsdoc/version.rb +3 -0
  160. data/public/images/jsdoc/icons/class.gif +0 -0
  161. data/public/images/jsdoc/icons/cmp.gif +0 -0
  162. data/public/images/jsdoc/icons/docs.gif +0 -0
  163. data/public/images/jsdoc/icons/elbow-end.gif +0 -0
  164. data/public/images/jsdoc/icons/elbow-minus.gif +0 -0
  165. data/public/images/jsdoc/icons/elbow-plus.gif +0 -0
  166. data/public/images/jsdoc/icons/elbow.gif +0 -0
  167. data/public/images/jsdoc/icons/event.gif +0 -0
  168. data/public/images/jsdoc/icons/inherited.gif +0 -0
  169. data/public/images/jsdoc/icons/method.gif +0 -0
  170. data/public/images/jsdoc/icons/pkg.gif +0 -0
  171. data/public/images/jsdoc/icons/prop.gif +0 -0
  172. data/public/images/jsdoc/icons/static.gif +0 -0
  173. data/public/javascripts/jsdoc/jsdoc.js +52 -0
  174. data/public/stylesheets/jsdoc/documentation.css +483 -0
  175. data/test/dummy/.gitignore +4 -0
  176. data/test/dummy/Rakefile +7 -0
  177. data/test/dummy/app/controllers/application_controller.rb +3 -0
  178. data/test/dummy/app/helpers/application_helper.rb +2 -0
  179. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  180. data/test/dummy/config.ru +4 -0
  181. data/test/dummy/config/application.rb +45 -0
  182. data/test/dummy/config/boot.rb +10 -0
  183. data/test/dummy/config/database.yml +22 -0
  184. data/test/dummy/config/environment.rb +5 -0
  185. data/test/dummy/config/environments/development.rb +26 -0
  186. data/test/dummy/config/environments/production.rb +49 -0
  187. data/test/dummy/config/environments/test.rb +35 -0
  188. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  189. data/test/dummy/config/initializers/inflections.rb +10 -0
  190. data/test/dummy/config/initializers/jsdoc.rb +5 -0
  191. data/test/dummy/config/initializers/mime_types.rb +5 -0
  192. data/test/dummy/config/initializers/secret_token.rb +7 -0
  193. data/test/dummy/config/initializers/session_store.rb +8 -0
  194. data/test/dummy/config/locales/en.yml +5 -0
  195. data/test/dummy/config/routes.rb +58 -0
  196. data/test/dummy/db/.gitkeep +0 -0
  197. data/test/dummy/public/404.html +26 -0
  198. data/test/dummy/public/422.html +26 -0
  199. data/test/dummy/public/500.html +26 -0
  200. data/test/dummy/public/favicon.ico +0 -0
  201. data/test/dummy/public/javascripts/application.js +2 -0
  202. data/test/dummy/public/javascripts/controls.js +965 -0
  203. data/test/dummy/public/javascripts/dragdrop.js +974 -0
  204. data/test/dummy/public/javascripts/effects.js +1123 -0
  205. data/test/dummy/public/javascripts/prototype.js +6001 -0
  206. data/test/dummy/public/javascripts/rails.js +175 -0
  207. data/test/dummy/public/stylesheets/.gitkeep +0 -0
  208. data/test/dummy/script/rails +6 -0
  209. data/test/integration/navigation_test.rb +7 -0
  210. data/test/jsdoc_test.rb +7 -0
  211. data/test/support/integration_case.rb +5 -0
  212. data/test/test_helper.rb +22 -0
  213. metadata +297 -0
@@ -0,0 +1,39 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
6
+
7
+ <title>JsDoc Reference - Index</title>
8
+ <meta name="generator" content="JsDoc Toolkit" />
9
+
10
+ <style type="text/css">
11
+ {+include("static/default.css")+}
12
+ </style>
13
+ </head>
14
+
15
+ <body>
16
+ {+include("static/header.html")+}
17
+
18
+ <div id="index">
19
+ {+publish.classesIndex+}
20
+ </div>
21
+
22
+ <div id="content">
23
+ <h1 class="classTitle">Class Index</h1>
24
+
25
+ <for each="thisClass" in="data">
26
+ <div>
27
+ <h2>{+(new Link().toSymbol(thisClass.alias))+}</h2>
28
+ {+resolveLinks(summarize(thisClass.classDesc))+}
29
+ </div>
30
+ <hr />
31
+ </for>
32
+
33
+ </div>
34
+ <div class="fineprint" style="clear:both">
35
+ <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
36
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
37
+ </div>
38
+ </body>
39
+ </html>
@@ -0,0 +1,201 @@
1
+ /** Called automatically by JsDoc Toolkit. */
2
+ function publish(symbolSet) {
3
+ publish.conf = { // trailing slash expected for dirs
4
+ ext: ".html",
5
+ outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",
6
+ templatesDir: JSDOC.opt.t || SYS.pwd+"../templates/jsdoc/",
7
+ symbolsDir: "symbols/",
8
+ srcDir: "symbols/src/"
9
+ };
10
+
11
+ // is source output is suppressed, just display the links to the source file
12
+ if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
13
+ Link.prototype._makeSrcLink = function(srcFilePath) {
14
+ return "&lt;"+srcFilePath+"&gt;";
15
+ }
16
+ }
17
+
18
+ // create the folders and subfolders to hold the output
19
+ IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
20
+
21
+ // used to allow Link to check the details of things being linked to
22
+ Link.symbolSet = symbolSet;
23
+
24
+ // create the required templates
25
+ try {
26
+ var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
27
+ var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl");
28
+ }
29
+ catch(e) {
30
+ print("Couldn't create the required templates: "+e);
31
+ quit();
32
+ }
33
+
34
+ // some ustility filters
35
+ function hasNoParent($) {return ($.memberOf == "")}
36
+ function isaFile($) {return ($.is("FILE"))}
37
+ function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)}
38
+
39
+ // get an array version of the symbolset, useful for filtering
40
+ var symbols = symbolSet.toArray();
41
+
42
+ // create the hilited source code files
43
+ var files = JSDOC.opt.srcFiles;
44
+ for (var i = 0, l = files.length; i < l; i++) {
45
+ var file = files[i];
46
+ var srcDir = publish.conf.outDir + "symbols/src/";
47
+ makeSrcFile(file, srcDir);
48
+ }
49
+
50
+ // get a list of all the classes in the symbolset
51
+ var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
52
+
53
+ // create a filemap in which outfiles must be to be named uniquely, ignoring case
54
+ if (JSDOC.opt.u) {
55
+ var filemapCounts = {};
56
+ Link.filemap = {};
57
+ for (var i = 0, l = classes.length; i < l; i++) {
58
+ var lcAlias = classes[i].alias.toLowerCase();
59
+
60
+ if (!filemapCounts[lcAlias]) filemapCounts[lcAlias] = 1;
61
+ else filemapCounts[lcAlias]++;
62
+
63
+ Link.filemap[classes[i].alias] =
64
+ (filemapCounts[lcAlias] > 1)?
65
+ lcAlias+"_"+filemapCounts[lcAlias] : lcAlias;
66
+ }
67
+ }
68
+
69
+ // create a class index, displayed in the left-hand column of every class page
70
+ Link.base = "../";
71
+ publish.classesIndex = classesTemplate.process(classes); // kept in memory
72
+
73
+ // create each of the class pages
74
+ for (var i = 0, l = classes.length; i < l; i++) {
75
+ var symbol = classes[i];
76
+
77
+ symbol.events = symbol.getEvents(); // 1 order matters
78
+ symbol.methods = symbol.getMethods(); // 2
79
+
80
+ Link.currentSymbol= symbol;
81
+ var output = "";
82
+ output = classTemplate.process(symbol);
83
+
84
+ IO.saveFile(publish.conf.outDir+"symbols/", ((JSDOC.opt.u)? Link.filemap[symbol.alias] : symbol.alias) + publish.conf.ext, output);
85
+ }
86
+
87
+ // regenerate the index with different relative links, used in the index pages
88
+ Link.base = "";
89
+ publish.classesIndex = classesTemplate.process(classes);
90
+
91
+ // create the class index page
92
+ try {
93
+ var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
94
+ }
95
+ catch(e) { print(e.message); quit(); }
96
+
97
+ var classesIndex = classesindexTemplate.process(classes);
98
+ IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
99
+ classesindexTemplate = classesIndex = classes = null;
100
+
101
+ // create the file index page
102
+ try {
103
+ var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
104
+ }
105
+ catch(e) { print(e.message); quit(); }
106
+
107
+ var documentedFiles = symbols.filter(isaFile); // files that have file-level docs
108
+ var allFiles = []; // not all files have file-level docs, but we need to list every one
109
+
110
+ for (var i = 0; i < files.length; i++) {
111
+ allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
112
+ }
113
+
114
+ for (var i = 0; i < documentedFiles.length; i++) {
115
+ var offset = files.indexOf(documentedFiles[i].alias);
116
+ allFiles[offset] = documentedFiles[i];
117
+ }
118
+
119
+ allFiles = allFiles.sort(makeSortby("name"));
120
+
121
+ // output the file index page
122
+ var filesIndex = fileindexTemplate.process(allFiles);
123
+ IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
124
+ fileindexTemplate = filesIndex = files = null;
125
+ }
126
+
127
+
128
+ /** Just the first sentence (up to a full stop). Should not break on dotted variable names. */
129
+ function summarize(desc) {
130
+ if (typeof desc != "undefined")
131
+ return desc.match(/([\w\W]+?\.)[^a-z0-9_$]/i)? RegExp.$1 : desc;
132
+ }
133
+
134
+ /** Make a symbol sorter by some attribute. */
135
+ function makeSortby(attribute) {
136
+ return function(a, b) {
137
+ if (a[attribute] != undefined && b[attribute] != undefined) {
138
+ a = a[attribute].toLowerCase();
139
+ b = b[attribute].toLowerCase();
140
+ if (a < b) return -1;
141
+ if (a > b) return 1;
142
+ return 0;
143
+ }
144
+ }
145
+ }
146
+
147
+ /** Pull in the contents of an external file at the given path. */
148
+ function include(path) {
149
+ var path = publish.conf.templatesDir+path;
150
+ return IO.readFile(path);
151
+ }
152
+
153
+ /** Turn a raw source file into a code-hilited page in the docs. */
154
+ function makeSrcFile(path, srcDir, name) {
155
+ if (JSDOC.opt.s) return;
156
+
157
+ if (!name) {
158
+ name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
159
+ name = name.replace(/\:/g, "_");
160
+ }
161
+
162
+ var src = {path: path, name:name, charset: IO.encoding, hilited: ""};
163
+
164
+ if (defined(JSDOC.PluginManager)) {
165
+ JSDOC.PluginManager.run("onPublishSrc", src);
166
+ }
167
+
168
+ if (src.hilited) {
169
+ IO.saveFile(srcDir, name+publish.conf.ext, src.hilited);
170
+ }
171
+ }
172
+
173
+ /** Build output for displaying function parameters. */
174
+ function makeSignature(params) {
175
+ if (!params) return "()";
176
+ var signature = "("
177
+ +
178
+ params.filter(
179
+ function($) {
180
+ return $.name.indexOf(".") == -1; // don't show config params in signature
181
+ }
182
+ ).map(
183
+ function($) {
184
+ return $.name;
185
+ }
186
+ ).join(", ")
187
+ +
188
+ ")";
189
+ return signature;
190
+ }
191
+
192
+ /** Find symbol {@link ...} strings in text and turn into html links */
193
+ function resolveLinks(str, from) {
194
+ str = str.replace(/\{@link ([^} ]+) ?\}/gi,
195
+ function(match, symbolName) {
196
+ return new Link().toSymbol(symbolName);
197
+ }
198
+ );
199
+
200
+ return str;
201
+ }
@@ -0,0 +1,162 @@
1
+ /* default.css */
2
+ body
3
+ {
4
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
5
+ width: 800px;
6
+ }
7
+
8
+ .header
9
+ {
10
+ clear: both;
11
+ background-color: #ccc;
12
+ padding: 8px;
13
+ }
14
+
15
+ h1
16
+ {
17
+ font-size: 150%;
18
+ font-weight: bold;
19
+ padding: 0;
20
+ margin: 1em 0 0 .3em;
21
+ }
22
+
23
+ hr
24
+ {
25
+ border: none 0;
26
+ border-top: 1px solid #7F8FB1;
27
+ height: 1px;
28
+ }
29
+
30
+ pre.code
31
+ {
32
+ display: block;
33
+ padding: 8px;
34
+ border: 1px dashed #ccc;
35
+ }
36
+
37
+ #index
38
+ {
39
+ margin-top: 24px;
40
+ float: left;
41
+ width: 160px;
42
+ position: absolute;
43
+ left: 8px;
44
+ background-color: #F3F3F3;
45
+ padding: 8px;
46
+ }
47
+
48
+ #content
49
+ {
50
+ margin-left: 190px;
51
+ width: 600px;
52
+ }
53
+
54
+ .classList
55
+ {
56
+ list-style-type: none;
57
+ padding: 0;
58
+ margin: 0 0 0 8px;
59
+ font-family: arial, sans-serif;
60
+ font-size: 1em;
61
+ overflow: auto;
62
+ }
63
+
64
+ .classList li
65
+ {
66
+ padding: 0;
67
+ margin: 0 0 8px 0;
68
+ }
69
+
70
+ .summaryTable { width: 100%; }
71
+
72
+ h1.classTitle
73
+ {
74
+ font-size:170%;
75
+ line-height:130%;
76
+ }
77
+
78
+ h2 { font-size: 110%; }
79
+ caption, div.sectionTitle
80
+ {
81
+ background-color: #7F8FB1;
82
+ color: #fff;
83
+ font-size:130%;
84
+ text-align: left;
85
+ padding: 2px 6px 2px 6px;
86
+ border: 1px #7F8FB1 solid;
87
+ }
88
+
89
+ div.sectionTitle { margin-bottom: 8px; }
90
+ .summaryTable thead { display: none; }
91
+
92
+ .summaryTable td
93
+ {
94
+ vertical-align: top;
95
+ padding: 4px;
96
+ border-bottom: 1px #7F8FB1 solid;
97
+ border-right: 1px #7F8FB1 solid;
98
+ }
99
+
100
+ /*col#summaryAttributes {}*/
101
+ .summaryTable td.attributes
102
+ {
103
+ border-left: 1px #7F8FB1 solid;
104
+ width: 140px;
105
+ text-align: right;
106
+ }
107
+
108
+ td.attributes, .fixedFont
109
+ {
110
+ line-height: 15px;
111
+ color: #002EBE;
112
+ font-family: "Courier New",Courier,monospace;
113
+ font-size: 13px;
114
+ }
115
+
116
+ .summaryTable td.nameDescription
117
+ {
118
+ text-align: left;
119
+ font-size: 13px;
120
+ line-height: 15px;
121
+ }
122
+
123
+ .summaryTable td.nameDescription, .description
124
+ {
125
+ line-height: 15px;
126
+ padding: 4px;
127
+ padding-left: 4px;
128
+ }
129
+
130
+ .summaryTable { margin-bottom: 8px; }
131
+
132
+ ul.inheritsList
133
+ {
134
+ list-style: square;
135
+ margin-left: 20px;
136
+ padding-left: 0;
137
+ }
138
+
139
+ .detailList {
140
+ margin-left: 20px;
141
+ line-height: 15px;
142
+ }
143
+ .detailList dt { margin-left: 20px; }
144
+
145
+ .detailList .heading
146
+ {
147
+ font-weight: bold;
148
+ padding-bottom: 6px;
149
+ margin-left: 0;
150
+ }
151
+
152
+ .light, td.attributes, .light a:link, .light a:visited
153
+ {
154
+ color: #777;
155
+ font-style: italic;
156
+ }
157
+
158
+ .fineprint
159
+ {
160
+ text-align: right;
161
+ font-size: 10px;
162
+ }
@@ -0,0 +1,2 @@
1
+ <div id="header">
2
+ </div>
@@ -0,0 +1,19 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
+ <title>Generated Javascript Documentation</title>
7
+ </head>
8
+ <frameset cols="20%,80%">
9
+ <frame src="allclasses-frame.html" name="packageFrame" />
10
+ <frame src="splash.html" name="classFrame" />
11
+ <noframes>
12
+ <body>
13
+ <p>
14
+ This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
15
+ </p>
16
+ </body>
17
+ </noframes>
18
+ </frameset>
19
+ </html>
@@ -0,0 +1,35 @@
1
+ <symbol alias="{+data.alias+}">
2
+ <name>{+data.name+}</name>
3
+ <memberOf>{+data.memberOf+}</memberOf>
4
+ <isStatic>{+data.isStatic+}</isStatic>
5
+ <isa>{+data.isa+}</isa>
6
+ <desc>{+data.desc+}</desc>
7
+ <classDesc>{+data.classDesc+}</classDesc>
8
+
9
+ <methods><for each="method" in="data.methods">
10
+ <method>
11
+ <name>{+method.name+}</name>
12
+ <memberOf>{+method.memberOf+}</memberOf>
13
+ <isStatic>{+method.isStatic+}</isStatic>
14
+ <desc>{+method.desc+}</desc>
15
+ <params><for each="param" in="method.params">
16
+ <param>
17
+ <type>{+param.type+}</type>
18
+ <name>{+param.name+}</name>
19
+ <desc>{+param.desc+}</desc>
20
+ <defaultValue>{+param.defaultValue+}</defaultValue>
21
+ </param></for>
22
+ </params>
23
+ </method></for>
24
+ </methods>
25
+
26
+ <properties><for each="property" in="data.properties">
27
+ <property>
28
+ <name>{+property.name+}</name>
29
+ <memberOf>{+property.memberOf+}</memberOf>
30
+ <isStatic>{+property.isStatic+}</isStatic>
31
+ <desc>{+property.desc+}</desc>
32
+ <type>{+property.type+}</type>
33
+ </property></for>
34
+ </properties>
35
+ </symbol>