jsdoc 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. data/LICENSE +20 -0
  2. data/README.rdoc +17 -0
  3. data/VERSION +1 -0
  4. data/bin/jsdoc +5 -0
  5. data/jsdoc.gemspec +162 -0
  6. data/lib/jsdoc-toolkit-2.4.0/README.txt +183 -0
  7. data/lib/jsdoc-toolkit-2.4.0/app/frame.js +33 -0
  8. data/lib/jsdoc-toolkit-2.4.0/app/frame/Chain.js +102 -0
  9. data/lib/jsdoc-toolkit-2.4.0/app/frame/Dumper.js +144 -0
  10. data/lib/jsdoc-toolkit-2.4.0/app/frame/Hash.js +84 -0
  11. data/lib/jsdoc-toolkit-2.4.0/app/frame/Link.js +173 -0
  12. data/lib/jsdoc-toolkit-2.4.0/app/frame/Namespace.js +10 -0
  13. data/lib/jsdoc-toolkit-2.4.0/app/frame/Opt.js +134 -0
  14. data/lib/jsdoc-toolkit-2.4.0/app/frame/Reflection.js +26 -0
  15. data/lib/jsdoc-toolkit-2.4.0/app/frame/String.js +93 -0
  16. data/lib/jsdoc-toolkit-2.4.0/app/frame/Testrun.js +129 -0
  17. data/lib/jsdoc-toolkit-2.4.0/app/handlers/FOODOC.js +26 -0
  18. data/lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC.js +26 -0
  19. data/lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/DomReader.js +159 -0
  20. data/lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLDoc.js +16 -0
  21. data/lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLParse.js +292 -0
  22. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC.js +106 -0
  23. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocComment.js +204 -0
  24. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocTag.js +294 -0
  25. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsDoc.js +140 -0
  26. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsPlate.js +109 -0
  27. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Lang.js +144 -0
  28. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Parser.js +146 -0
  29. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/PluginManager.js +33 -0
  30. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Symbol.js +644 -0
  31. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/SymbolSet.js +243 -0
  32. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TextStream.js +41 -0
  33. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Token.js +18 -0
  34. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenReader.js +332 -0
  35. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenStream.js +133 -0
  36. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Util.js +32 -0
  37. data/lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Walker.js +507 -0
  38. data/lib/jsdoc-toolkit-2.4.0/app/main.js +111 -0
  39. data/lib/jsdoc-toolkit-2.4.0/app/plugins/commentSrcJson.js +20 -0
  40. data/lib/jsdoc-toolkit-2.4.0/app/plugins/frameworkPrototype.js +16 -0
  41. data/lib/jsdoc-toolkit-2.4.0/app/plugins/functionCall.js +10 -0
  42. data/lib/jsdoc-toolkit-2.4.0/app/plugins/publishSrcHilite.js +62 -0
  43. data/lib/jsdoc-toolkit-2.4.0/app/plugins/symbolLink.js +10 -0
  44. data/lib/jsdoc-toolkit-2.4.0/app/plugins/tagParamConfig.js +31 -0
  45. data/lib/jsdoc-toolkit-2.4.0/app/plugins/tagSynonyms.js +43 -0
  46. data/lib/jsdoc-toolkit-2.4.0/app/run.js +348 -0
  47. data/lib/jsdoc-toolkit-2.4.0/app/t/TestDoc.js +144 -0
  48. data/lib/jsdoc-toolkit-2.4.0/app/t/runner.js +13 -0
  49. data/lib/jsdoc-toolkit-2.4.0/app/test.js +342 -0
  50. data/lib/jsdoc-toolkit-2.4.0/app/test/addon.js +24 -0
  51. data/lib/jsdoc-toolkit-2.4.0/app/test/anon_inner.js +14 -0
  52. data/lib/jsdoc-toolkit-2.4.0/app/test/augments.js +31 -0
  53. data/lib/jsdoc-toolkit-2.4.0/app/test/augments2.js +26 -0
  54. data/lib/jsdoc-toolkit-2.4.0/app/test/borrows.js +46 -0
  55. data/lib/jsdoc-toolkit-2.4.0/app/test/borrows2.js +23 -0
  56. data/lib/jsdoc-toolkit-2.4.0/app/test/config.js +22 -0
  57. data/lib/jsdoc-toolkit-2.4.0/app/test/constructs.js +18 -0
  58. data/lib/jsdoc-toolkit-2.4.0/app/test/encoding.js +10 -0
  59. data/lib/jsdoc-toolkit-2.4.0/app/test/encoding_other.js +12 -0
  60. data/lib/jsdoc-toolkit-2.4.0/app/test/event.js +54 -0
  61. data/lib/jsdoc-toolkit-2.4.0/app/test/exports.js +14 -0
  62. data/lib/jsdoc-toolkit-2.4.0/app/test/functions_anon.js +39 -0
  63. data/lib/jsdoc-toolkit-2.4.0/app/test/functions_nested.js +33 -0
  64. data/lib/jsdoc-toolkit-2.4.0/app/test/global.js +13 -0
  65. data/lib/jsdoc-toolkit-2.4.0/app/test/globals.js +25 -0
  66. data/lib/jsdoc-toolkit-2.4.0/app/test/ignore.js +10 -0
  67. data/lib/jsdoc-toolkit-2.4.0/app/test/inner.js +16 -0
  68. data/lib/jsdoc-toolkit-2.4.0/app/test/jsdoc_test.js +477 -0
  69. data/lib/jsdoc-toolkit-2.4.0/app/test/lend.js +33 -0
  70. data/lib/jsdoc-toolkit-2.4.0/app/test/memberof.js +19 -0
  71. data/lib/jsdoc-toolkit-2.4.0/app/test/memberof2.js +38 -0
  72. data/lib/jsdoc-toolkit-2.4.0/app/test/memberof3.js +33 -0
  73. data/lib/jsdoc-toolkit-2.4.0/app/test/memberof_constructor.js +17 -0
  74. data/lib/jsdoc-toolkit-2.4.0/app/test/module.js +17 -0
  75. data/lib/jsdoc-toolkit-2.4.0/app/test/multi_methods.js +25 -0
  76. data/lib/jsdoc-toolkit-2.4.0/app/test/name.js +19 -0
  77. data/lib/jsdoc-toolkit-2.4.0/app/test/namespace_nested.js +23 -0
  78. data/lib/jsdoc-toolkit-2.4.0/app/test/nocode.js +13 -0
  79. data/lib/jsdoc-toolkit-2.4.0/app/test/oblit_anon.js +20 -0
  80. data/lib/jsdoc-toolkit-2.4.0/app/test/overview.js +20 -0
  81. data/lib/jsdoc-toolkit-2.4.0/app/test/param_inline.js +37 -0
  82. data/lib/jsdoc-toolkit-2.4.0/app/test/params_optional.js +8 -0
  83. data/lib/jsdoc-toolkit-2.4.0/app/test/prototype.js +17 -0
  84. data/lib/jsdoc-toolkit-2.4.0/app/test/prototype_nested.js +9 -0
  85. data/lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit.js +13 -0
  86. data/lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit_constructor.js +24 -0
  87. data/lib/jsdoc-toolkit-2.4.0/app/test/public.js +10 -0
  88. data/lib/jsdoc-toolkit-2.4.0/app/test/scripts/code.js +5 -0
  89. data/lib/jsdoc-toolkit-2.4.0/app/test/scripts/notcode.txt +5 -0
  90. data/lib/jsdoc-toolkit-2.4.0/app/test/shared.js +42 -0
  91. data/lib/jsdoc-toolkit-2.4.0/app/test/shared2.js +2 -0
  92. data/lib/jsdoc-toolkit-2.4.0/app/test/shortcuts.js +22 -0
  93. data/lib/jsdoc-toolkit-2.4.0/app/test/static_this.js +13 -0
  94. data/lib/jsdoc-toolkit-2.4.0/app/test/synonyms.js +31 -0
  95. data/lib/jsdoc-toolkit-2.4.0/app/test/tosource.js +23 -0
  96. data/lib/jsdoc-toolkit-2.4.0/app/test/variable_redefine.js +14 -0
  97. data/lib/jsdoc-toolkit-2.4.0/changes.txt +124 -0
  98. data/lib/jsdoc-toolkit-2.4.0/conf/sample.conf +31 -0
  99. data/lib/jsdoc-toolkit-2.4.0/java/build.xml +36 -0
  100. data/lib/jsdoc-toolkit-2.4.0/java/build_1.4.xml +36 -0
  101. data/lib/jsdoc-toolkit-2.4.0/java/classes/js.jar +0 -0
  102. data/lib/jsdoc-toolkit-2.4.0/java/src/JsDebugRun.java +21 -0
  103. data/lib/jsdoc-toolkit-2.4.0/java/src/JsRun.java +21 -0
  104. data/lib/jsdoc-toolkit-2.4.0/jsdebug.jar +0 -0
  105. data/lib/jsdoc-toolkit-2.4.0/jsrun.jar +0 -0
  106. data/lib/jsdoc-toolkit-2.4.0/jsrun.sh +52 -0
  107. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allclasses.tmpl +17 -0
  108. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allfiles.tmpl +56 -0
  109. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/class.tmpl +649 -0
  110. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/index.tmpl +39 -0
  111. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/publish.js +201 -0
  112. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/default.css +162 -0
  113. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/header.html +2 -0
  114. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/index.html +19 -0
  115. data/lib/jsdoc-toolkit-2.4.0/templates/jsdoc/symbol.tmpl +35 -0
  116. data/lib/jsdoc.rb +23 -0
  117. data/test/helper.rb +10 -0
  118. data/test/test_jsdoc.rb +7 -0
  119. metadata +199 -0
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2010 Incandescent Software
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,17 @@
1
+ = jsdoc-gem
2
+
3
+ Description goes here.
4
+
5
+ == Note on Patches/Pull Requests
6
+
7
+ * Fork the project.
8
+ * Make your feature addition or bug fix.
9
+ * Add tests for it. This is important so I don't break it in a
10
+ future version unintentionally.
11
+ * Commit, do not mess with rakefile, version, or history.
12
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
13
+ * Send me a pull request. Bonus points for topic branches.
14
+
15
+ == Copyright
16
+
17
+ Copyright (c) 2010 Incandescent Software. See LICENSE for details.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'jsdoc'
4
+
5
+ JsDoc.new.run *ARGV
@@ -0,0 +1,162 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{jsdoc}
8
+ s.version = "0.1.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Aaron Hamid"]
12
+ s.date = %q{2010-11-19}
13
+ s.default_executable = %q{jsdoc}
14
+ s.description = %q{a wrapper around jsdoc}
15
+ s.email = %q{aaron@incandescentsoftware.com}
16
+ s.executables = ["jsdoc"]
17
+ s.extra_rdoc_files = [
18
+ "LICENSE",
19
+ "README.rdoc"
20
+ ]
21
+ s.files = [
22
+ "LICENSE",
23
+ "README.rdoc",
24
+ "VERSION",
25
+ "bin/jsdoc",
26
+ "jsdoc.gemspec",
27
+ "lib/jsdoc-toolkit-2.4.0/README.txt",
28
+ "lib/jsdoc-toolkit-2.4.0/app/frame.js",
29
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Chain.js",
30
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Dumper.js",
31
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Hash.js",
32
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Link.js",
33
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Namespace.js",
34
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Opt.js",
35
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Reflection.js",
36
+ "lib/jsdoc-toolkit-2.4.0/app/frame/String.js",
37
+ "lib/jsdoc-toolkit-2.4.0/app/frame/Testrun.js",
38
+ "lib/jsdoc-toolkit-2.4.0/app/handlers/FOODOC.js",
39
+ "lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC.js",
40
+ "lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/DomReader.js",
41
+ "lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLDoc.js",
42
+ "lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLParse.js",
43
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC.js",
44
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocComment.js",
45
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocTag.js",
46
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsDoc.js",
47
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsPlate.js",
48
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Lang.js",
49
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Parser.js",
50
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/PluginManager.js",
51
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Symbol.js",
52
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/SymbolSet.js",
53
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TextStream.js",
54
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Token.js",
55
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenReader.js",
56
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenStream.js",
57
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Util.js",
58
+ "lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Walker.js",
59
+ "lib/jsdoc-toolkit-2.4.0/app/main.js",
60
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/commentSrcJson.js",
61
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/frameworkPrototype.js",
62
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/functionCall.js",
63
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/publishSrcHilite.js",
64
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/symbolLink.js",
65
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/tagParamConfig.js",
66
+ "lib/jsdoc-toolkit-2.4.0/app/plugins/tagSynonyms.js",
67
+ "lib/jsdoc-toolkit-2.4.0/app/run.js",
68
+ "lib/jsdoc-toolkit-2.4.0/app/t/TestDoc.js",
69
+ "lib/jsdoc-toolkit-2.4.0/app/t/runner.js",
70
+ "lib/jsdoc-toolkit-2.4.0/app/test.js",
71
+ "lib/jsdoc-toolkit-2.4.0/app/test/addon.js",
72
+ "lib/jsdoc-toolkit-2.4.0/app/test/anon_inner.js",
73
+ "lib/jsdoc-toolkit-2.4.0/app/test/augments.js",
74
+ "lib/jsdoc-toolkit-2.4.0/app/test/augments2.js",
75
+ "lib/jsdoc-toolkit-2.4.0/app/test/borrows.js",
76
+ "lib/jsdoc-toolkit-2.4.0/app/test/borrows2.js",
77
+ "lib/jsdoc-toolkit-2.4.0/app/test/config.js",
78
+ "lib/jsdoc-toolkit-2.4.0/app/test/constructs.js",
79
+ "lib/jsdoc-toolkit-2.4.0/app/test/encoding.js",
80
+ "lib/jsdoc-toolkit-2.4.0/app/test/encoding_other.js",
81
+ "lib/jsdoc-toolkit-2.4.0/app/test/event.js",
82
+ "lib/jsdoc-toolkit-2.4.0/app/test/exports.js",
83
+ "lib/jsdoc-toolkit-2.4.0/app/test/functions_anon.js",
84
+ "lib/jsdoc-toolkit-2.4.0/app/test/functions_nested.js",
85
+ "lib/jsdoc-toolkit-2.4.0/app/test/global.js",
86
+ "lib/jsdoc-toolkit-2.4.0/app/test/globals.js",
87
+ "lib/jsdoc-toolkit-2.4.0/app/test/ignore.js",
88
+ "lib/jsdoc-toolkit-2.4.0/app/test/inner.js",
89
+ "lib/jsdoc-toolkit-2.4.0/app/test/jsdoc_test.js",
90
+ "lib/jsdoc-toolkit-2.4.0/app/test/lend.js",
91
+ "lib/jsdoc-toolkit-2.4.0/app/test/memberof.js",
92
+ "lib/jsdoc-toolkit-2.4.0/app/test/memberof2.js",
93
+ "lib/jsdoc-toolkit-2.4.0/app/test/memberof3.js",
94
+ "lib/jsdoc-toolkit-2.4.0/app/test/memberof_constructor.js",
95
+ "lib/jsdoc-toolkit-2.4.0/app/test/module.js",
96
+ "lib/jsdoc-toolkit-2.4.0/app/test/multi_methods.js",
97
+ "lib/jsdoc-toolkit-2.4.0/app/test/name.js",
98
+ "lib/jsdoc-toolkit-2.4.0/app/test/namespace_nested.js",
99
+ "lib/jsdoc-toolkit-2.4.0/app/test/nocode.js",
100
+ "lib/jsdoc-toolkit-2.4.0/app/test/oblit_anon.js",
101
+ "lib/jsdoc-toolkit-2.4.0/app/test/overview.js",
102
+ "lib/jsdoc-toolkit-2.4.0/app/test/param_inline.js",
103
+ "lib/jsdoc-toolkit-2.4.0/app/test/params_optional.js",
104
+ "lib/jsdoc-toolkit-2.4.0/app/test/prototype.js",
105
+ "lib/jsdoc-toolkit-2.4.0/app/test/prototype_nested.js",
106
+ "lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit.js",
107
+ "lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit_constructor.js",
108
+ "lib/jsdoc-toolkit-2.4.0/app/test/public.js",
109
+ "lib/jsdoc-toolkit-2.4.0/app/test/scripts/code.js",
110
+ "lib/jsdoc-toolkit-2.4.0/app/test/scripts/notcode.txt",
111
+ "lib/jsdoc-toolkit-2.4.0/app/test/shared.js",
112
+ "lib/jsdoc-toolkit-2.4.0/app/test/shared2.js",
113
+ "lib/jsdoc-toolkit-2.4.0/app/test/shortcuts.js",
114
+ "lib/jsdoc-toolkit-2.4.0/app/test/static_this.js",
115
+ "lib/jsdoc-toolkit-2.4.0/app/test/synonyms.js",
116
+ "lib/jsdoc-toolkit-2.4.0/app/test/tosource.js",
117
+ "lib/jsdoc-toolkit-2.4.0/app/test/variable_redefine.js",
118
+ "lib/jsdoc-toolkit-2.4.0/changes.txt",
119
+ "lib/jsdoc-toolkit-2.4.0/conf/sample.conf",
120
+ "lib/jsdoc-toolkit-2.4.0/java/build.xml",
121
+ "lib/jsdoc-toolkit-2.4.0/java/build_1.4.xml",
122
+ "lib/jsdoc-toolkit-2.4.0/java/classes/js.jar",
123
+ "lib/jsdoc-toolkit-2.4.0/java/src/JsDebugRun.java",
124
+ "lib/jsdoc-toolkit-2.4.0/java/src/JsRun.java",
125
+ "lib/jsdoc-toolkit-2.4.0/jsdebug.jar",
126
+ "lib/jsdoc-toolkit-2.4.0/jsrun.jar",
127
+ "lib/jsdoc-toolkit-2.4.0/jsrun.sh",
128
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allclasses.tmpl",
129
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allfiles.tmpl",
130
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/class.tmpl",
131
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/index.tmpl",
132
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/publish.js",
133
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/default.css",
134
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/header.html",
135
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/index.html",
136
+ "lib/jsdoc-toolkit-2.4.0/templates/jsdoc/symbol.tmpl",
137
+ "lib/jsdoc.rb"
138
+ ]
139
+ s.homepage = %q{http://github.com/incandescent/jsdoc-gem}
140
+ s.rdoc_options = ["--charset=UTF-8"]
141
+ s.require_paths = ["lib"]
142
+ s.rubygems_version = %q{1.3.7}
143
+ s.summary = %q{a wrapper around jsdoc}
144
+ s.test_files = [
145
+ "test/test_jsdoc.rb",
146
+ "test/helper.rb"
147
+ ]
148
+
149
+ if s.respond_to? :specification_version then
150
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
151
+ s.specification_version = 3
152
+
153
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
154
+ s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
155
+ else
156
+ s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
157
+ end
158
+ else
159
+ s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
160
+ end
161
+ end
162
+
@@ -0,0 +1,183 @@
1
+ ======================================================================
2
+
3
+ DESCRIPTION:
4
+
5
+ This is the source code for JsDoc Toolkit, an automatic documentation
6
+ generation tool for JavaScript. It is written in JavaScript and is run
7
+ from a command line (or terminal) using Java and Mozilla's Rhino
8
+ JavaScript runtime engine.
9
+
10
+ Using this tool you can automatically turn JavaDoc-like comments in
11
+ your JavaScript source code into published output files, such as HTML
12
+ or XML.
13
+
14
+ For more information, to report a bug, or to browse the technical
15
+ documentation for this tool please visit the official JsDoc Toolkit
16
+ project homepage at http://code.google.com/p/jsdoc-toolkit/
17
+
18
+ For the most up-to-date documentation on JsDoc Toolkit see the
19
+ official wiki at http://code.google.com/p/jsdoc-toolkit/w/list
20
+
21
+ ======================================================================
22
+
23
+ REQUIREMENTS:
24
+
25
+ JsDoc Toolkit is known to work with:
26
+ java version "1.6.0_03"
27
+ Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
28
+ on Windows XP,
29
+ and java version "1.5.0_19"
30
+ Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)
31
+ on Mac OS X 10.5.
32
+
33
+ Other versions of java may or may not work with JsDoc Toolkit.
34
+
35
+ ======================================================================
36
+
37
+ USAGE:
38
+
39
+ Running JsDoc Toolkit requires you to have Java installed on your
40
+ computer. For more information see http://www.java.com/getjava/
41
+
42
+ Before running the JsDoc Toolkit app you should change your current
43
+ working directory to the jsdoc-toolkit folder. Then follow the
44
+ examples below, or as shown on the project wiki.
45
+
46
+ On a computer running Windows a valid command line to run JsDoc
47
+ Toolkit might look like this:
48
+
49
+ > java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js
50
+
51
+ On Mac OS X or Linux the same command would look like this:
52
+
53
+ $ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js
54
+
55
+ The above assumes your current working directory contains jsrun.jar,
56
+ the "app" and "templates" subdirectories from the standard JsDoc
57
+ Toolkit distribution and that the relative path to the code you wish
58
+ to document is "mycode.js".
59
+
60
+ The output documentation files will be saved to a new directory named
61
+ "out" (by default) in the current directory, or if you specify a
62
+ -d=somewhere_else option, to the somewhere_else directory.
63
+
64
+ For help (usage notes) enter this on the command line:
65
+
66
+ $ java -jar jsrun.jar app/run.js --help
67
+
68
+ More information about the various command line options used by JsDoc
69
+ Toolkit are available on the project wiki.
70
+
71
+ ======================================================================
72
+
73
+ RUNNING VIA SHELL SCRIPT
74
+
75
+ Avi Deitcher has contributed the file jsrun.sh with the following usage notes:
76
+
77
+ A script to simplify running jsdoc from the command-line, especially when
78
+ running from within a development or build environment such as ant.
79
+
80
+ Normally, to run jsdoc, you need a command-line as the following:
81
+ java -Djsdoc.dir=/some/long/dir/path/to/jsdoc -jar
82
+ /some/long/dir/path/to/jsdoc/jsrun.jar /some/long/dir/path/to/jsdoc/app/run.js
83
+ -t=template -r=4 /some/long/dir/path/to/my/src/code
84
+
85
+ This can get tedious to redo time and again, and difficult to use from within a build environment.
86
+
87
+ To simplify the process, jsrun.sh will automatically run this path, as well as passing through any arguments.
88
+
89
+ Usage: jsrun.sh <run.js arguments>
90
+
91
+ All <run.js arguments> will be passed through.
92
+ Additionally, jsrun.sh will take the following actions:
93
+ 1) If the environment variable JSDOCDIR is set, it will add
94
+ "-Djsdoc.dir=$JSDOCDIR" to the command-line
95
+ 2) If the environment variable JSDOCTEMPLATEDIR is set, it will add
96
+ "-Djsdoc.template.dir=$JSDOCTEMPLATEDIR" to the command-line
97
+ 3) java with the appropriate path to jsrun.jar and run.js will be instantiated
98
+
99
+ If not variables are set, it is assumed that the path to jsrun.jar and app/ is in the current working directory.
100
+
101
+ Example:
102
+ # jsrun.sh ./src/
103
+ Assuming JSDOCDIR=/some/path/to/my/jsdoc will cause the following command to
104
+ execute:
105
+ java -Djsdoc.dir=/some/path/to/my/jsdoc -jar /some/path/to/my/jsdoc/jsrun.jar
106
+ /some/path/to/my/jsdoc/app/run.js ./src/
107
+
108
+ ======================================================================
109
+
110
+ TESTING:
111
+
112
+ To run the suite of unit tests included with JsDoc Toolkit enter this
113
+ on the command line:
114
+
115
+ $ java -jar jsrun.jar app/run.js -T
116
+
117
+ To see a dump of the internal data structure that JsDoc Toolkit has
118
+ built from your source files use this command:
119
+
120
+ $ java -jar jsrun.jar app/run.js mycode.js -Z
121
+
122
+ ======================================================================
123
+
124
+ LICENSE:
125
+
126
+ JSDoc.pm
127
+
128
+ This project is based on the JSDoc.pm tool, created by Michael
129
+ Mathews and Gabriel Reid. More information on JsDoc.pm can
130
+ be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
131
+
132
+ Complete documentation on JsDoc Toolkit can be found on the project
133
+ wiki at http://code.google.com/p/jsdoc-toolkit/w/list
134
+
135
+ Rhino
136
+
137
+ Rhino (JavaScript in Java) is open source and licensed by Mozilla
138
+ under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of
139
+ which is available at http://www.mozilla.org/MPL/
140
+
141
+ You can obtain the source code for Rhino from the Mozilla web site at
142
+ http://www.mozilla.org/rhino/download.html
143
+
144
+ JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
145
+ but is not derived from it in any way. The Rhino library is used
146
+ without modification and without any claims whatsoever.
147
+
148
+ The Rhino Debugger
149
+
150
+ You can obtain more information about the Rhino Debugger from the
151
+ Mozilla web site at http://www.mozilla.org/rhino/debugger.html
152
+
153
+ JsDoc Toolkit is a larger work that uses the Rhino Debugger but
154
+ is not derived from it in any way. The Rhino Debugger is used
155
+ without modification and without any claims whatsoever.
156
+
157
+ JsDoc Toolkit
158
+
159
+ All code specific to JsDoc Toolkit are free, open source and licensed
160
+ for use under the X11/MIT License.
161
+
162
+ JsDoc Toolkit is Copyright (c)2009 Michael Mathews <micmath@gmail.com>
163
+
164
+ This program is free software; you can redistribute it and/or
165
+ modify it under the terms below.
166
+
167
+ Permission is hereby granted, free of charge, to any person obtaining
168
+ a copy of this software and associated documentation files (the
169
+ "Software"), to deal in the Software without restriction, including
170
+ without limitation the rights to use, copy, modify, merge, publish,
171
+ distribute, sublicense, and/or sell copies of the Software, and to
172
+ permit persons to whom the Software is furnished to do so, subject to
173
+ the following conditions: The above copyright notice and this
174
+ permission notice must be included in all copies or substantial
175
+ portions of the Software.
176
+
177
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
178
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
179
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
180
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
181
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
182
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
183
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,33 @@
1
+ IO.include("frame/Opt.js");
2
+ IO.include("frame/Chain.js");
3
+ IO.include("frame/Link.js");
4
+ IO.include("frame/String.js");
5
+ IO.include("frame/Hash.js");
6
+ IO.include("frame/Namespace.js");
7
+ //IO.include("frame/Reflection.js");
8
+
9
+ /** A few helper functions to make life a little easier. */
10
+
11
+ function defined(o) {
12
+ return (o !== undefined);
13
+ }
14
+
15
+ function copy(o) { // todo check for circular refs
16
+ if (o == null || typeof(o) != 'object') return o;
17
+ var c = new o.constructor();
18
+ for(var p in o) c[p] = copy(o[p]);
19
+ return c;
20
+ }
21
+
22
+ function isUnique(arr) {
23
+ var l = arr.length;
24
+ for(var i = 0; i < l; i++ ) {
25
+ if (arr.lastIndexOf(arr[i]) > i) return false;
26
+ }
27
+ return true;
28
+ }
29
+
30
+ /** Returns the given string with all regex meta characters backslashed. */
31
+ RegExp.escapeMeta = function(str) {
32
+ return str.replace(/([$^\\\/()|?+*\[\]{}.-])/g, "\\$1");
33
+ }
@@ -0,0 +1,102 @@
1
+ /**@constructor*/
2
+ function ChainNode(object, link) {
3
+ this.value = object;
4
+ this.link = link; // describes this node's relationship to the previous node
5
+ }
6
+
7
+ /**@constructor*/
8
+ function Chain(valueLinks) {
9
+ this.nodes = [];
10
+ this.cursor = -1;
11
+
12
+ if (valueLinks && valueLinks.length > 0) {
13
+ this.push(valueLinks[0], "//");
14
+ for (var i = 1, l = valueLinks.length; i < l; i+=2) {
15
+ this.push(valueLinks[i+1], valueLinks[i]);
16
+ }
17
+ }
18
+ }
19
+
20
+ Chain.prototype.push = function(o, link) {
21
+ if (this.nodes.length > 0 && link) this.nodes.push(new ChainNode(o, link));
22
+ else this.nodes.push(new ChainNode(o));
23
+ }
24
+
25
+ Chain.prototype.unshift = function(o, link) {
26
+ if (this.nodes.length > 0 && link) this.nodes[0].link = link;
27
+ this.nodes.unshift(new ChainNode(o));
28
+ this.cursor++;
29
+ }
30
+
31
+ Chain.prototype.get = function() {
32
+ if (this.cursor < 0 || this.cursor > this.nodes.length-1) return null;
33
+ return this.nodes[this.cursor];
34
+ }
35
+
36
+ Chain.prototype.first = function() {
37
+ this.cursor = 0;
38
+ return this.get();
39
+ }
40
+
41
+ Chain.prototype.last = function() {
42
+ this.cursor = this.nodes.length-1;
43
+ return this.get();
44
+ }
45
+
46
+ Chain.prototype.next = function() {
47
+ this.cursor++;
48
+ return this.get();
49
+ }
50
+
51
+ Chain.prototype.prev = function() {
52
+ this.cursor--;
53
+ return this.get();
54
+ }
55
+
56
+ Chain.prototype.toString = function() {
57
+ var string = "";
58
+ for (var i = 0, l = this.nodes.length; i < l; i++) {
59
+ if (this.nodes[i].link) string += " -("+this.nodes[i].link+")-> ";
60
+ string += this.nodes[i].value.toString();
61
+ }
62
+ return string;
63
+ }
64
+
65
+ Chain.prototype.joinLeft = function() {
66
+ var result = "";
67
+ for (var i = 0, l = this.cursor; i < l; i++) {
68
+ if (result && this.nodes[i].link) result += this.nodes[i].link;
69
+ result += this.nodes[i].value.toString();
70
+ }
71
+ return result;
72
+ }
73
+
74
+
75
+ /* USAGE:
76
+
77
+ var path = "one/two/three.four/five-six";
78
+ var pathChain = new Chain(path.split(/([\/.-])/));
79
+ print(pathChain);
80
+
81
+ var lineage = new Chain();
82
+ lineage.push("Port");
83
+ lineage.push("Les", "son");
84
+ lineage.push("Dawn", "daughter");
85
+ lineage.unshift("Purdie", "son");
86
+
87
+ print(lineage);
88
+
89
+ // walk left
90
+ for (var node = lineage.last(); node !== null; node = lineage.prev()) {
91
+ print("< "+node.value);
92
+ }
93
+
94
+ // walk right
95
+ var node = lineage.first()
96
+ while (node !== null) {
97
+ print(node.value);
98
+ node = lineage.next();
99
+ if (node && node.link) print("had a "+node.link+" named");
100
+ }
101
+
102
+ */