jsc3d-rails 1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (144) hide show
  1. data/.gitignore +8 -0
  2. data/Gemfile +4 -0
  3. data/LICENSE +21 -0
  4. data/README.md +33 -0
  5. data/jsc3d-rails.gemspec +23 -0
  6. data/lib/generators/jquery/install/install_generator.rb +59 -0
  7. data/lib/jsc3d-rails.rb +1 -0
  8. data/lib/jsc3d/rails.rb +8 -0
  9. data/lib/jsc3d/rails/engine.rb +6 -0
  10. data/lib/jsc3d/rails/version.rb +6 -0
  11. data/vendor/assets/javascripts/bin/jsc3d.min.js +139 -0
  12. data/vendor/assets/javascripts/bin/jsc3d_ie.min.js +133 -0
  13. data/vendor/assets/javascripts/build/compile.bat +1 -0
  14. data/vendor/assets/javascripts/build/compile.sh +2 -0
  15. data/vendor/assets/javascripts/build/gendoc.bat +2 -0
  16. data/vendor/assets/javascripts/build/gendoc.sh +2 -0
  17. data/vendor/assets/javascripts/docs/files.html +247 -0
  18. data/vendor/assets/javascripts/docs/index.html +349 -0
  19. data/vendor/assets/javascripts/docs/symbols/JSC3D.AABB.html +436 -0
  20. data/vendor/assets/javascripts/docs/symbols/JSC3D.BinaryStream.html +1051 -0
  21. data/vendor/assets/javascripts/docs/symbols/JSC3D.LoaderSelector.html +455 -0
  22. data/vendor/assets/javascripts/docs/symbols/JSC3D.Material.html +430 -0
  23. data/vendor/assets/javascripts/docs/symbols/JSC3D.Math3D.html +468 -0
  24. data/vendor/assets/javascripts/docs/symbols/JSC3D.Matrix3x4.html +682 -0
  25. data/vendor/assets/javascripts/docs/symbols/JSC3D.Mesh.html +628 -0
  26. data/vendor/assets/javascripts/docs/symbols/JSC3D.ObjLoader.html +428 -0
  27. data/vendor/assets/javascripts/docs/symbols/JSC3D.PickInfo.html +332 -0
  28. data/vendor/assets/javascripts/docs/symbols/JSC3D.Scene.html +571 -0
  29. data/vendor/assets/javascripts/docs/symbols/JSC3D.StlLoader.html +473 -0
  30. data/vendor/assets/javascripts/docs/symbols/JSC3D.Texture.html +589 -0
  31. data/vendor/assets/javascripts/docs/symbols/JSC3D.Viewer.html +1156 -0
  32. data/vendor/assets/javascripts/docs/symbols/JSC3D.html +329 -0
  33. data/vendor/assets/javascripts/docs/symbols/_global_.html +279 -0
  34. data/vendor/assets/javascripts/docs/symbols/src/jsc3d.js.html +4804 -0
  35. data/vendor/assets/javascripts/jsc3d.console.js +146 -0
  36. data/vendor/assets/javascripts/jsc3d.js +4796 -0
  37. data/vendor/assets/javascripts/jsc3d_ie.js +4487 -0
  38. data/vendor/assets/javascripts/tools/closure/COPYING +202 -0
  39. data/vendor/assets/javascripts/tools/closure/README +261 -0
  40. data/vendor/assets/javascripts/tools/closure/USAGE +87 -0
  41. data/vendor/assets/javascripts/tools/closure/compiler.jar +0 -0
  42. data/vendor/assets/javascripts/tools/doc_generator/README.txt +146 -0
  43. data/vendor/assets/javascripts/tools/doc_generator/app/frame.js +33 -0
  44. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Chain.js +102 -0
  45. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Dumper.js +144 -0
  46. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Hash.js +84 -0
  47. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Link.js +148 -0
  48. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Namespace.js +10 -0
  49. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Opt.js +134 -0
  50. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Reflection.js +26 -0
  51. data/vendor/assets/javascripts/tools/doc_generator/app/frame/String.js +93 -0
  52. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Testrun.js +129 -0
  53. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/FOODOC.js +26 -0
  54. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC.js +26 -0
  55. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/DomReader.js +159 -0
  56. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/XMLDoc.js +16 -0
  57. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/XMLParse.js +292 -0
  58. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC.js +101 -0
  59. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/DocComment.js +200 -0
  60. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/DocTag.js +294 -0
  61. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/JsDoc.js +126 -0
  62. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/JsPlate.js +109 -0
  63. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Lang.js +144 -0
  64. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Parser.js +107 -0
  65. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/PluginManager.js +33 -0
  66. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Symbol.js +643 -0
  67. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/SymbolSet.js +229 -0
  68. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TextStream.js +41 -0
  69. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Token.js +18 -0
  70. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TokenReader.js +332 -0
  71. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TokenStream.js +133 -0
  72. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Util.js +32 -0
  73. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Walker.js +459 -0
  74. data/vendor/assets/javascripts/tools/doc_generator/app/main.js +111 -0
  75. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/commentSrcJson.js +20 -0
  76. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/frameworkPrototype.js +16 -0
  77. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/functionCall.js +10 -0
  78. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/publishSrcHilite.js +62 -0
  79. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/symbolLink.js +9 -0
  80. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/tagParamConfig.js +31 -0
  81. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/tagSynonyms.js +43 -0
  82. data/vendor/assets/javascripts/tools/doc_generator/app/run.js +348 -0
  83. data/vendor/assets/javascripts/tools/doc_generator/app/t/TestDoc.js +144 -0
  84. data/vendor/assets/javascripts/tools/doc_generator/app/t/runner.js +13 -0
  85. data/vendor/assets/javascripts/tools/doc_generator/app/test.js +307 -0
  86. data/vendor/assets/javascripts/tools/doc_generator/app/test/addon.js +24 -0
  87. data/vendor/assets/javascripts/tools/doc_generator/app/test/anon_inner.js +14 -0
  88. data/vendor/assets/javascripts/tools/doc_generator/app/test/augments.js +31 -0
  89. data/vendor/assets/javascripts/tools/doc_generator/app/test/augments2.js +26 -0
  90. data/vendor/assets/javascripts/tools/doc_generator/app/test/borrows.js +41 -0
  91. data/vendor/assets/javascripts/tools/doc_generator/app/test/borrows2.js +23 -0
  92. data/vendor/assets/javascripts/tools/doc_generator/app/test/config.js +22 -0
  93. data/vendor/assets/javascripts/tools/doc_generator/app/test/constructs.js +18 -0
  94. data/vendor/assets/javascripts/tools/doc_generator/app/test/encoding.js +10 -0
  95. data/vendor/assets/javascripts/tools/doc_generator/app/test/encoding_other.js +12 -0
  96. data/vendor/assets/javascripts/tools/doc_generator/app/test/event.js +54 -0
  97. data/vendor/assets/javascripts/tools/doc_generator/app/test/functions_anon.js +39 -0
  98. data/vendor/assets/javascripts/tools/doc_generator/app/test/functions_nested.js +33 -0
  99. data/vendor/assets/javascripts/tools/doc_generator/app/test/global.js +13 -0
  100. data/vendor/assets/javascripts/tools/doc_generator/app/test/globals.js +25 -0
  101. data/vendor/assets/javascripts/tools/doc_generator/app/test/ignore.js +10 -0
  102. data/vendor/assets/javascripts/tools/doc_generator/app/test/inner.js +16 -0
  103. data/vendor/assets/javascripts/tools/doc_generator/app/test/jsdoc_test.js +477 -0
  104. data/vendor/assets/javascripts/tools/doc_generator/app/test/lend.js +33 -0
  105. data/vendor/assets/javascripts/tools/doc_generator/app/test/memberof.js +19 -0
  106. data/vendor/assets/javascripts/tools/doc_generator/app/test/memberof_constructor.js +17 -0
  107. data/vendor/assets/javascripts/tools/doc_generator/app/test/name.js +19 -0
  108. data/vendor/assets/javascripts/tools/doc_generator/app/test/namespace_nested.js +23 -0
  109. data/vendor/assets/javascripts/tools/doc_generator/app/test/nocode.js +13 -0
  110. data/vendor/assets/javascripts/tools/doc_generator/app/test/oblit_anon.js +20 -0
  111. data/vendor/assets/javascripts/tools/doc_generator/app/test/overview.js +20 -0
  112. data/vendor/assets/javascripts/tools/doc_generator/app/test/param_inline.js +37 -0
  113. data/vendor/assets/javascripts/tools/doc_generator/app/test/params_optional.js +8 -0
  114. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype.js +17 -0
  115. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_nested.js +9 -0
  116. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_oblit.js +13 -0
  117. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_oblit_constructor.js +24 -0
  118. data/vendor/assets/javascripts/tools/doc_generator/app/test/public.js +10 -0
  119. data/vendor/assets/javascripts/tools/doc_generator/app/test/shared.js +42 -0
  120. data/vendor/assets/javascripts/tools/doc_generator/app/test/shared2.js +2 -0
  121. data/vendor/assets/javascripts/tools/doc_generator/app/test/shortcuts.js +22 -0
  122. data/vendor/assets/javascripts/tools/doc_generator/app/test/static_this.js +13 -0
  123. data/vendor/assets/javascripts/tools/doc_generator/app/test/synonyms.js +31 -0
  124. data/vendor/assets/javascripts/tools/doc_generator/app/test/tosource.js +23 -0
  125. data/vendor/assets/javascripts/tools/doc_generator/app/test/variable_redefine.js +14 -0
  126. data/vendor/assets/javascripts/tools/doc_generator/changes.txt +75 -0
  127. data/vendor/assets/javascripts/tools/doc_generator/conf/sample.conf +31 -0
  128. data/vendor/assets/javascripts/tools/doc_generator/java/build.xml +36 -0
  129. data/vendor/assets/javascripts/tools/doc_generator/java/build_1.4.xml +36 -0
  130. data/vendor/assets/javascripts/tools/doc_generator/java/classes/js.jar +0 -0
  131. data/vendor/assets/javascripts/tools/doc_generator/java/src/JsDebugRun.java +21 -0
  132. data/vendor/assets/javascripts/tools/doc_generator/java/src/JsRun.java +21 -0
  133. data/vendor/assets/javascripts/tools/doc_generator/jsdebug.jar +0 -0
  134. data/vendor/assets/javascripts/tools/doc_generator/jsrun.jar +0 -0
  135. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/allclasses.tmpl +17 -0
  136. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/allfiles.tmpl +56 -0
  137. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/class.tmpl +646 -0
  138. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/index.tmpl +39 -0
  139. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/publish.js +184 -0
  140. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/default.css +165 -0
  141. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/header.html +2 -0
  142. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/index.html +19 -0
  143. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/symbol.tmpl +35 -0
  144. metadata +234 -0
@@ -0,0 +1,101 @@
1
+ /**
2
+ @overview
3
+ @date $Date: 2009-01-21 22:53:36 +0000 (Wed, 21 Jan 2009) $
4
+ @version $Revision: 771 $
5
+ @location $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2.1.0/jsdoc-toolkit/app/lib/JSDOC.js $
6
+ @name whateverFilename.js
7
+ */
8
+
9
+ /**
10
+ This is the main container for the JSDOC application.
11
+ @namespace
12
+ */
13
+ JSDOC = {
14
+ };
15
+
16
+ /**
17
+ @requires Opt
18
+ */
19
+ if (typeof arguments == "undefined") arguments = [];
20
+ JSDOC.opt = Opt.get(
21
+ arguments,
22
+ {
23
+ d: "directory",
24
+ c: "conf",
25
+ t: "template",
26
+ r: "recurse",
27
+ x: "ext",
28
+ p: "private",
29
+ a: "allfunctions",
30
+ e: "encoding",
31
+ n: "nocode",
32
+ o: "out",
33
+ s: "suppress",
34
+ q: "quiet",
35
+ T: "testmode",
36
+ h: "help",
37
+ v: "verbose",
38
+ "D[]": "define",
39
+ "E[]": "exclude",
40
+ "H[]": "handler"
41
+ }
42
+ );
43
+
44
+ /** The current version string of this application. */
45
+ JSDOC.VERSION = "2.1.0";
46
+
47
+ /** Print out usage information and quit. */
48
+ JSDOC.usage = function() {
49
+ print("USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...");
50
+ print("");
51
+ print("OPTIONS:");
52
+ print(" -a or --allfunctions\n Include all functions, even undocumented ones.\n");
53
+ print(" -c or --conf\n Load a configuration file.\n");
54
+ print(" -d=<PATH> or --directory=<PATH>\n Output to this directory (defaults to \"out\").\n");
55
+ print(" -D=\"myVar:My value\" or --define=\"myVar:My value\"\n Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.\n");
56
+ print(" -e=<ENCODING> or --encoding=<ENCODING>\n Use this encoding to read and write files.\n");
57
+ print(" -E=\"REGEX\" or --exclude=\"REGEX\"\n Multiple. Exclude files based on the supplied regex.\n");
58
+ print(" -h or --help\n Show this message and exit.\n");
59
+ print(" -n or --nocode\n Ignore all code, only document comments with @name tags.\n");
60
+ print(" -o=<PATH> or --out=<PATH>\n Print log messages to a file (defaults to stdout).\n");
61
+ print(" -p or --private\n Include symbols tagged as private, underscored and inner symbols.\n");
62
+ print(" -q or --quiet\n Do not output any messages, not even warnings.\n");
63
+ print(" -r=<DEPTH> or --recurse=<DEPTH>\n Descend into src directories.\n");
64
+ print(" -s or --suppress\n Suppress source code output.\n");
65
+ print(" -t=<PATH> or --template=<PATH>\n Required. Use this template to format the output.\n");
66
+ print(" -T or --test\n Run all unit tests and exit.\n");
67
+ print(" -v or --verbose\n Provide verbose feedback about what is happening.\n");
68
+ print(" -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n Scan source files with the given extension/s (defaults to js).\n");
69
+
70
+ quit();
71
+ }
72
+
73
+ /*t:
74
+ plan(4, "Testing JSDOC namespace.");
75
+
76
+ is(
77
+ typeof JSDOC,
78
+ "object",
79
+ "JSDOC.usage is a function."
80
+ );
81
+
82
+ is(
83
+ typeof JSDOC.VERSION,
84
+ "string",
85
+ "JSDOC.VERSION is a string."
86
+ );
87
+
88
+ is(
89
+ typeof JSDOC.usage,
90
+ "function",
91
+ "JSDOC.usage is a function."
92
+ );
93
+
94
+ is(
95
+ typeof JSDOC.opt,
96
+ "object",
97
+ "JSDOC.opt is a object."
98
+ );
99
+ */
100
+
101
+ if (this.IO) IO.includeDir("lib/JSDOC/");
@@ -0,0 +1,200 @@
1
+ if (typeof JSDOC == "undefined") JSDOC = {};
2
+
3
+ /**
4
+ Create a new DocComment. This takes a raw documentation comment,
5
+ and wraps it in useful accessors.
6
+ @class Represents a documentation comment object.
7
+ */
8
+ JSDOC.DocComment = function(/**String*/comment) {
9
+ this.init();
10
+ if (typeof comment != "undefined") {
11
+ this.parse(comment);
12
+ }
13
+ }
14
+
15
+ JSDOC.DocComment.prototype.init = function() {
16
+ this.isUserComment = true;
17
+ this.src = "";
18
+ this.meta = "";
19
+ this.tagTexts = [];
20
+ this.tags = [];
21
+ }
22
+
23
+ /**
24
+ @requires JSDOC.DocTag
25
+ */
26
+ JSDOC.DocComment.prototype.parse = function(/**String*/comment) {
27
+ if (comment == "") {
28
+ comment = "/** @desc */";
29
+ this.isUserComment = false;
30
+ }
31
+
32
+ this.src = JSDOC.DocComment.unwrapComment(comment);
33
+
34
+ this.meta = "";
35
+ if (this.src.indexOf("#") == 0) {
36
+ this.src.match(/#(.+[+-])([\s\S]*)$/);
37
+ if (RegExp.$1) this.meta = RegExp.$1;
38
+ if (RegExp.$2) this.src = RegExp.$2;
39
+ }
40
+
41
+ if (typeof JSDOC.PluginManager != "undefined") {
42
+ JSDOC.PluginManager.run("onDocCommentSrc", this);
43
+ }
44
+
45
+ this.fixDesc();
46
+
47
+ this.src = JSDOC.DocComment.shared+"\n"+this.src;
48
+
49
+ this.tagTexts =
50
+ this.src
51
+ .split(/(^|[\r\n])\s*@/)
52
+ .filter(function($){return $.match(/\S/)});
53
+
54
+ /**
55
+ The tags found in the comment.
56
+ @type JSDOC.DocTag[]
57
+ */
58
+ this.tags = this.tagTexts.map(function($){return new JSDOC.DocTag($)});
59
+
60
+ if (typeof JSDOC.PluginManager != "undefined") {
61
+ JSDOC.PluginManager.run("onDocCommentTags", this);
62
+ }
63
+ }
64
+
65
+ /*t:
66
+ plan(5, "testing JSDOC.DocComment");
67
+ requires("../frame/String.js");
68
+ requires("../lib/JSDOC/DocTag.js");
69
+
70
+ var com = new JSDOC.DocComment("/**@foo some\n* comment here*"+"/");
71
+ is(com.tagTexts[0], "foo some\ncomment here", "first tag text is found.");
72
+ is(com.tags[0].title, "foo", "the title is found in a comment with one tag.");
73
+
74
+ var com = new JSDOC.DocComment("/** @foo first\n* @bar second*"+"/");
75
+ is(com.getTag("bar").length, 1, "getTag() returns one tag by that title.");
76
+
77
+ JSDOC.DocComment.shared = "@author John Smith";
78
+ var com = new JSDOC.DocComment("/**@foo some\n* comment here*"+"/");
79
+ is(com.tags[0].title, "author", "shared comment is added.");
80
+ is(com.tags[1].title, "foo", "shared comment is added to existing tag.");
81
+ */
82
+
83
+ /**
84
+ If no @desc tag is provided, this function will add it.
85
+ */
86
+ JSDOC.DocComment.prototype.fixDesc = function() {
87
+ if (this.meta && this.meta != "@+") return;
88
+ if (/^\s*[^@\s]/.test(this.src)) {
89
+ this.src = "@desc "+this.src;
90
+ }
91
+ }
92
+
93
+ /*t:
94
+ plan(5, "testing JSDOC.DocComment#fixDesc");
95
+
96
+ var com = new JSDOC.DocComment();
97
+
98
+ com.src = "this is a desc\n@author foo";
99
+ com.fixDesc();
100
+ is(com.src, "@desc this is a desc\n@author foo", "if no @desc tag is provided one is added.");
101
+
102
+ com.src = "x";
103
+ com.fixDesc();
104
+ is(com.src, "@desc x", "if no @desc tag is provided one is added to a single character.");
105
+
106
+ com.src = "\nx";
107
+ com.fixDesc();
108
+ is(com.src, "@desc \nx", "if no @desc tag is provided one is added to return and character.");
109
+
110
+ com.src = " ";
111
+ com.fixDesc();
112
+ is(com.src, " ", "if no @desc tag is provided one is not added to just whitespace.");
113
+
114
+ com.src = "";
115
+ com.fixDesc();
116
+ is(com.src, "", "if no @desc tag is provided one is not added to empty.");
117
+ */
118
+
119
+ /**
120
+ Remove slash-star comment wrapper from a raw comment string.
121
+ @type String
122
+ */
123
+ JSDOC.DocComment.unwrapComment = function(/**String*/comment) {
124
+ if (!comment) return "";
125
+ var unwrapped = comment.replace(/(^\/\*\*|\*\/$)/g, "").replace(/^\s*\* ?/gm, "");
126
+ return unwrapped;
127
+ }
128
+
129
+ /*t:
130
+ plan(5, "testing JSDOC.DocComment.unwrapComment");
131
+
132
+ var com = "/**x*"+"/";
133
+ var unwrapped = JSDOC.DocComment.unwrapComment(com);
134
+ is(unwrapped, "x", "a single character jsdoc is found.");
135
+
136
+ com = "/***x*"+"/";
137
+ unwrapped = JSDOC.DocComment.unwrapComment(com);
138
+ is(unwrapped, "x", "three stars are allowed in the opener.");
139
+
140
+ com = "/****x*"+"/";
141
+ unwrapped = JSDOC.DocComment.unwrapComment(com);
142
+ is(unwrapped, "*x", "fourth star in the opener is kept.");
143
+
144
+ com = "/**x\n * y\n*"+"/";
145
+ unwrapped = JSDOC.DocComment.unwrapComment(com);
146
+ is(unwrapped, "x\ny\n", "leading stars and spaces are trimmed.");
147
+
148
+ com = "/**x\n * y\n*"+"/";
149
+ unwrapped = JSDOC.DocComment.unwrapComment(com);
150
+ is(unwrapped, "x\n y\n", "only first space after leading stars are trimmed.");
151
+ */
152
+
153
+ /**
154
+ Provides a printable version of the comment.
155
+ @type String
156
+ */
157
+ JSDOC.DocComment.prototype.toString = function() {
158
+ return this.src;
159
+ }
160
+
161
+ /*t:
162
+ plan(1, "testing JSDOC.DocComment#fixDesc");
163
+ var com = new JSDOC.DocComment();
164
+ com.src = "foo";
165
+ is(""+com, "foo", "stringifying a comment returns the unwrapped src.");
166
+ */
167
+
168
+ /**
169
+ Given the title of a tag, returns all tags that have that title.
170
+ @type JSDOC.DocTag[]
171
+ */
172
+ JSDOC.DocComment.prototype.getTag = function(/**String*/tagTitle) {
173
+ return this.tags.filter(function($){return $.title == tagTitle});
174
+ }
175
+
176
+ /*t:
177
+ plan(1, "testing JSDOC.DocComment#getTag");
178
+ requires("../frame/String.js");
179
+ requires("../lib/JSDOC/DocTag.js");
180
+
181
+ var com = new JSDOC.DocComment("/**@foo some\n* @bar\n* @bar*"+"/");
182
+ is(com.getTag("bar").length, 2, "getTag returns expected number of tags.");
183
+ */
184
+
185
+ /**
186
+ Used to store the currently shared tag text.
187
+ */
188
+ JSDOC.DocComment.shared = "";
189
+
190
+ /*t:
191
+ plan(2, "testing JSDOC.DocComment.shared");
192
+ requires("../frame/String.js");
193
+ requires("../lib/JSDOC/DocTag.js");
194
+
195
+ JSDOC.DocComment.shared = "@author Michael";
196
+
197
+ var com = new JSDOC.DocComment("/**@foo\n* @foo*"+"/");
198
+ is(com.getTag("author").length, 1, "getTag returns shared tag.");
199
+ is(com.getTag("foo").length, 2, "getTag returns unshared tags too.");
200
+ */
@@ -0,0 +1,294 @@
1
+ if (typeof JSDOC == "undefined") JSDOC = {};
2
+
3
+ /**
4
+ @constructor
5
+ */
6
+ JSDOC.DocTag = function(src) {
7
+ this.init();
8
+ if (typeof src != "undefined") {
9
+ this.parse(src);
10
+ }
11
+ }
12
+
13
+ /**
14
+ Create and initialize the properties of this.
15
+ */
16
+ JSDOC.DocTag.prototype.init = function() {
17
+ this.title = "";
18
+ this.type = "";
19
+ this.name = "";
20
+ this.isOptional = false;
21
+ this.defaultValue = "";
22
+ this.desc = "";
23
+
24
+ return this;
25
+ }
26
+
27
+ /**
28
+ Populate the properties of this from the given tag src.
29
+ @param {string} src
30
+ */
31
+ JSDOC.DocTag.prototype.parse = function(src) {
32
+ if (typeof src != "string") throw "src must be a string not "+(typeof src);
33
+
34
+ try {
35
+ src = this.nibbleTitle(src);
36
+ if (JSDOC.PluginManager) {
37
+ JSDOC.PluginManager.run("onDocTagSynonym", this);
38
+ }
39
+
40
+ src = this.nibbleType(src);
41
+
42
+ // only some tags are allowed to have names.
43
+ if (this.title == "param" || this.title == "property" || this.title == "config") { // @config is deprecated
44
+ src = this.nibbleName(src);
45
+ }
46
+ }
47
+ catch(e) {
48
+ if (LOG) LOG.warn(e);
49
+ else throw e;
50
+ }
51
+ this.desc = src; // whatever is left
52
+
53
+ // example tags need to have whitespace preserved
54
+ if (this.title != "example") this.desc = this.desc.trim();
55
+
56
+ if (JSDOC.PluginManager) {
57
+ JSDOC.PluginManager.run("onDocTag", this);
58
+ }
59
+ }
60
+
61
+ /**
62
+ Automatically called when this is stringified.
63
+ */
64
+ JSDOC.DocTag.prototype.toString = function() {
65
+ return this.desc;
66
+ }
67
+
68
+ /*t:
69
+ plan(1, "testing JSDOC.DocTag#toString");
70
+
71
+ var tag = new JSDOC.DocTag("param {object} date A valid date.");
72
+ is(""+tag, "A valid date.", "stringifying a tag returns the desc.");
73
+ */
74
+
75
+ /**
76
+ Find and shift off the title of a tag.
77
+ @param {string} src
78
+ @return src
79
+ */
80
+ JSDOC.DocTag.prototype.nibbleTitle = function(src) {
81
+ if (typeof src != "string") throw "src must be a string not "+(typeof src);
82
+
83
+ var parts = src.match(/^\s*(\S+)(?:\s([\s\S]*))?$/);
84
+
85
+ if (parts && parts[1]) this.title = parts[1];
86
+ if (parts && parts[2]) src = parts[2];
87
+ else src = "";
88
+
89
+ return src;
90
+ }
91
+
92
+ /*t:
93
+ plan(8, "testing JSDOC.DocTag#nibbleTitle");
94
+
95
+ var tag = new JSDOC.DocTag();
96
+
97
+ tag.init().nibbleTitle("aTitleGoesHere");
98
+ is(tag.title, "aTitleGoesHere", "a title can be found in a single-word string.");
99
+
100
+ var src = tag.init().nibbleTitle("aTitleGoesHere and the rest");
101
+ is(tag.title, "aTitleGoesHere", "a title can be found in a multi-word string.");
102
+ is(src, "and the rest", "the rest is returned when the title is nibbled off.");
103
+
104
+ src = tag.init().nibbleTitle("");
105
+ is(tag.title, "", "given an empty string the title is empty.");
106
+ is(src, "", "the rest is empty when the tag is empty.");
107
+
108
+ var src = tag.init().nibbleTitle(" aTitleGoesHere\n a description");
109
+ is(tag.title, "aTitleGoesHere", "leading and trailing spaces are not part of the title.");
110
+ is(src, " a description", "leading spaces (less one) are part of the description.");
111
+
112
+ tag.init().nibbleTitle("a.Title::Goes_Here foo");
113
+ is(tag.title, "a.Title::Goes_Here", "titles with punctuation are allowed.");
114
+ */
115
+
116
+ /**
117
+ Find and shift off the type of a tag.
118
+ @requires frame/String.js
119
+ @param {string} src
120
+ @return src
121
+ */
122
+ JSDOC.DocTag.prototype.nibbleType = function(src) {
123
+ if (typeof src != "string") throw "src must be a string not "+(typeof src);
124
+
125
+ if (src.match(/^\s*\{/)) {
126
+ var typeRange = src.balance("{", "}");
127
+ if (typeRange[1] == -1) {
128
+ throw "Malformed comment tag ignored. Tag type requires an opening { and a closing }: "+src;
129
+ }
130
+ this.type = src.substring(typeRange[0]+1, typeRange[1]).trim();
131
+ this.type = this.type.replace(/\s*,\s*/g, "|"); // multiples can be separated by , or |
132
+ src = src.substring(typeRange[1]+1);
133
+ }
134
+
135
+ return src;
136
+ }
137
+
138
+ /*t:
139
+ plan(5, "testing JSDOC.DocTag.parser.nibbleType");
140
+ requires("../frame/String.js");
141
+
142
+ var tag = new JSDOC.DocTag();
143
+
144
+ tag.init().nibbleType("{String[]} aliases");
145
+ is(tag.type, "String[]", "type can have non-alpha characters.");
146
+
147
+ tag.init().nibbleType("{ aTypeGoesHere } etc etc");
148
+ is(tag.type, "aTypeGoesHere", "type is trimmed.");
149
+
150
+ tag.init().nibbleType("{ oneType, twoType ,\n threeType } etc etc");
151
+ is(tag.type, "oneType|twoType|threeType", "multiple types can be separated by commas.");
152
+
153
+ var error;
154
+ try { tag.init().nibbleType("{widget foo"); }
155
+ catch(e) { error = e; }
156
+ is(typeof error, "string", "malformed tag type throws error.");
157
+ isnt(error.indexOf("Malformed"), -1, "error message tells tag is malformed.");
158
+ */
159
+
160
+ /**
161
+ Find and shift off the name of a tag.
162
+ @requires frame/String.js
163
+ @param {string} src
164
+ @return src
165
+ */
166
+ JSDOC.DocTag.prototype.nibbleName = function(src) {
167
+ if (typeof src != "string") throw "src must be a string not "+(typeof src);
168
+
169
+ src = src.trim();
170
+
171
+ // is optional?
172
+ if (src.charAt(0) == "[") {
173
+ var nameRange = src.balance("[", "]");
174
+ if (nameRange[1] == -1) {
175
+ throw "Malformed comment tag ignored. Tag optional name requires an opening [ and a closing ]: "+src;
176
+ }
177
+ this.name = src.substring(nameRange[0]+1, nameRange[1]).trim();
178
+ this.isOptional = true;
179
+
180
+ src = src.substring(nameRange[1]+1);
181
+
182
+ // has default value?
183
+ var nameAndValue = this.name.split("=");
184
+ if (nameAndValue.length) {
185
+ this.name = nameAndValue.shift().trim();
186
+ this.defaultValue = nameAndValue.join("=");
187
+ }
188
+ }
189
+ else {
190
+ var parts = src.match(/^(\S+)(?:\s([\s\S]*))?$/);
191
+ if (parts) {
192
+ if (parts[1]) this.name = parts[1];
193
+ if (parts[2]) src = parts[2].trim();
194
+ else src = "";
195
+ }
196
+ }
197
+
198
+ return src;
199
+ }
200
+
201
+ /*t:
202
+ requires("../frame/String.js");
203
+ plan(9, "testing JSDOC.DocTag.parser.nibbleName");
204
+
205
+ var tag = new JSDOC.DocTag();
206
+
207
+ tag.init().nibbleName("[foo] This is a description.");
208
+ is(tag.isOptional, true, "isOptional syntax is detected.");
209
+ is(tag.name, "foo", "optional param name is found.");
210
+
211
+ tag.init().nibbleName("[foo] This is a description.");
212
+ is(tag.isOptional, true, "isOptional syntax is detected when no type.");
213
+ is(tag.name, "foo", "optional param name is found when no type.");
214
+
215
+ tag.init().nibbleName("[foo=7] This is a description.");
216
+ is(tag.name, "foo", "optional param name is found when default value.");
217
+ is(tag.defaultValue, 7, "optional param default value is found when default value.");
218
+
219
+ //tag.init().nibbleName("[foo= a value] This is a description.");
220
+ //is(tag.defaultValue, " a value", "optional param default value is found when default value has spaces (issue #112).");
221
+
222
+ tag.init().nibbleName("[foo=[]] This is a description.");
223
+ is(tag.defaultValue, "[]", "optional param default value is found when default value is [] (issue #95).");
224
+
225
+ tag.init().nibbleName("[foo=a=b] This is a description.");
226
+ is(tag.name, "foo", "optional param name is found when default value is a=b.");
227
+ is(tag.defaultValue, "a=b", "optional param default value is found when default value is a=b.")
228
+ */
229
+
230
+ /*t:
231
+ plan(32, "Testing JSDOC.DocTag.parser.");
232
+ requires("../frame/String.js");
233
+
234
+ var tag = new JSDOC.DocTag();
235
+
236
+ is(typeof tag, "object", "JSDOC.DocTag.parser with an empty string returns an object.");
237
+ is(typeof tag.title, "string", "returned object has a string property 'title'.");
238
+ is(typeof tag.type, "string", "returned object has a string property 'type'.");
239
+ is(typeof tag.name, "string", "returned object has a string property 'name'.");
240
+ is(typeof tag.defaultValue, "string", "returned object has a string property 'defaultValue'.");
241
+ is(typeof tag.isOptional, "boolean", "returned object has a boolean property 'isOptional'.");
242
+ is(typeof tag.desc, "string", "returned object has a string property 'desc'.");
243
+
244
+ tag = new JSDOC.DocTag("param {widget} foo");
245
+ is(tag.title, "param", "param title is found.");
246
+ is(tag.name, "foo", "param name is found when desc is missing.");
247
+ is(tag.desc, "", "param desc is empty when missing.");
248
+
249
+ tag = new JSDOC.DocTag("param {object} date A valid date.");
250
+ is(tag.name, "date", "param name is found with a type.");
251
+ is(tag.type, "object", "param type is found.");
252
+ is(tag.desc, "A valid date.", "param desc is found with a type.");
253
+
254
+ tag = new JSDOC.DocTag("param aName a description goes\n here.");
255
+ is(tag.name, "aName", "param name is found without a type.");
256
+ is(tag.desc, "a description goes\n here.", "param desc is found without a type.");
257
+
258
+ tag = new JSDOC.DocTag("param {widget}");
259
+ is(tag.name, "", "param name is empty when it is not given.");
260
+
261
+ tag = new JSDOC.DocTag("param {widget} [foo] This is a description.");
262
+ is(tag.name, "foo", "optional param name is found.");
263
+
264
+ tag = new JSDOC.DocTag("return {aType} This is a description.");
265
+ is(tag.type, "aType", "when return tag has no name, type is found.");
266
+ is(tag.desc, "This is a description.", "when return tag has no name, desc is found.");
267
+
268
+ tag = new JSDOC.DocTag("author Joe Coder <jcoder@example.com>");
269
+ is(tag.title, "author", "author tag has a title.");
270
+ is(tag.type, "", "the author tag has no type.");
271
+ is(tag.name, "", "the author tag has no name.");
272
+ is(tag.desc, "Joe Coder <jcoder@example.com>", "author tag has desc.");
273
+
274
+ tag = new JSDOC.DocTag("private \t\n ");
275
+ is(tag.title, "private", "private tag has a title.");
276
+ is(tag.type, "", "the private tag has no type.");
277
+ is(tag.name, "", "the private tag has no name.");
278
+ is(tag.desc, "", "private tag has no desc.");
279
+
280
+ tag = new JSDOC.DocTag("example\n example(code);\n more();");
281
+ is(tag.desc, " example(code);\n more();", "leading whitespace (less one) in examples code is preserved.");
282
+
283
+ tag = new JSDOC.DocTag("param theName \n");
284
+ is(tag.name, "theName", "name only is found.");
285
+
286
+ tag = new JSDOC.DocTag("type theDesc \n");
287
+ is(tag.desc, "theDesc", "desc only is found.");
288
+
289
+ tag = new JSDOC.DocTag("type {theType} \n");
290
+ is(tag.type, "theType", "type only is found.");
291
+
292
+ tag = new JSDOC.DocTag("");
293
+ is(tag.title, "", "title is empty when tag is empty.");
294
+ */