sc-docs 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (162) hide show
  1. data/.gitignore +4 -0
  2. data/.gitmodules +3 -0
  3. data/Gemfile +5 -0
  4. data/Gemfile.lock +48 -0
  5. data/LICENSE +21 -0
  6. data/README.md +59 -0
  7. data/bin/sc-docs +5 -0
  8. data/lib/sc_docs.rb +3 -0
  9. data/lib/sc_docs/cli.rb +54 -0
  10. data/lib/sc_docs/docs/Buildfile +8 -0
  11. data/lib/sc_docs/docs/README +8 -0
  12. data/lib/sc_docs/docs/apps/docs/Buildfile +15 -0
  13. data/lib/sc_docs/docs/apps/docs/controllers/classes.js +27 -0
  14. data/lib/sc_docs/docs/apps/docs/controllers/search_controller.js +62 -0
  15. data/lib/sc_docs/docs/apps/docs/controllers/selected_class.js +143 -0
  16. data/lib/sc_docs/docs/apps/docs/core.js +148 -0
  17. data/lib/sc_docs/docs/apps/docs/main.js +41 -0
  18. data/lib/sc_docs/docs/apps/docs/models/class.js +63 -0
  19. data/lib/sc_docs/docs/apps/docs/models/entity.js +29 -0
  20. data/lib/sc_docs/docs/apps/docs/models/method.js +79 -0
  21. data/lib/sc_docs/docs/apps/docs/models/property.js +48 -0
  22. data/lib/sc_docs/docs/apps/docs/resources/images/method_icon.png +0 -0
  23. data/lib/sc_docs/docs/apps/docs/resources/images/property_icon.png +0 -0
  24. data/lib/sc_docs/docs/apps/docs/resources/loading.rhtml +9 -0
  25. data/lib/sc_docs/docs/apps/docs/resources/main_page.css +156 -0
  26. data/lib/sc_docs/docs/apps/docs/resources/main_page.js +91 -0
  27. data/lib/sc_docs/docs/apps/docs/resources/templates/details.handlebars +81 -0
  28. data/lib/sc_docs/docs/apps/docs/resources/templates/extensions/signature.js +0 -0
  29. data/lib/sc_docs/docs/apps/docs/system/jquery_ui.js +62 -0
  30. data/lib/sc_docs/docs/apps/docs/system/showdown.js +1297 -0
  31. data/lib/sc_docs/docs/apps/docs/theme.js +29 -0
  32. data/lib/sc_docs/docs/apps/docs/views/detail_list.js +24 -0
  33. data/lib/sc_docs/docs/apps/docs/views/master_list.js +35 -0
  34. data/lib/sc_docs/docs/apps/docs/views/methods_collection.js +80 -0
  35. data/lib/sc_docs/docs/apps/docs/views/properties_collection.js +9 -0
  36. data/lib/sc_docs/generator.rb +145 -0
  37. data/lib/sc_docs/server.rb +21 -0
  38. data/lib/sc_docs/templates/docs.sproutcore.com/allclasses.tmpl +31 -0
  39. data/lib/sc_docs/templates/docs.sproutcore.com/allfiles.tmpl +66 -0
  40. data/lib/sc_docs/templates/docs.sproutcore.com/class.tmpl +437 -0
  41. data/lib/sc_docs/templates/docs.sproutcore.com/index.tmpl +52 -0
  42. data/lib/sc_docs/templates/docs.sproutcore.com/output/css/api.css +619 -0
  43. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/apidocs.jpg +0 -0
  44. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/apidocs.png +0 -0
  45. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/clearinput.png +0 -0
  46. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/cross.png +0 -0
  47. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/ddiagonal.png +0 -0
  48. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/diagonal.png +0 -0
  49. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/docbullet.jpg +0 -0
  50. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/docbullet.png +0 -0
  51. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/glow.png +0 -0
  52. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/logo.png +0 -0
  53. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/pixels.png +0 -0
  54. data/lib/sc_docs/templates/docs.sproutcore.com/output/img/search.png +0 -0
  55. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/api.js +134 -0
  56. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/jquery-bbq.js +18 -0
  57. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/lib/jquery-1.5.1.min.js +16 -0
  58. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/lib/modernizr-1.7.min.js +2 -0
  59. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/plugin.js +1 -0
  60. data/lib/sc_docs/templates/docs.sproutcore.com/output/js/script.js +5 -0
  61. data/lib/sc_docs/templates/docs.sproutcore.com/publish.js +200 -0
  62. data/lib/sc_docs/templates/docs.sproutcore.com/static/default.css +300 -0
  63. data/lib/sc_docs/templates/docs.sproutcore.com/static/header.html +19 -0
  64. data/lib/sc_docs/templates/docs.sproutcore.com/static/index.html +19 -0
  65. data/lib/sc_docs/templates/docs.sproutcore.com/symbol.tmpl +35 -0
  66. data/lib/sc_docs/templates/sc_fixture/publish.js +632 -0
  67. data/lib/sc_docs/version.rb +4 -0
  68. data/sc_docs.gemspec +27 -0
  69. data/vendor/jsdoc/README.txt +109 -0
  70. data/vendor/jsdoc/app/frame.js +33 -0
  71. data/vendor/jsdoc/app/frame/Chain.js +102 -0
  72. data/vendor/jsdoc/app/frame/Dumper.js +144 -0
  73. data/vendor/jsdoc/app/frame/Hash.js +84 -0
  74. data/vendor/jsdoc/app/frame/Link.js +173 -0
  75. data/vendor/jsdoc/app/frame/Namespace.js +10 -0
  76. data/vendor/jsdoc/app/frame/Opt.js +134 -0
  77. data/vendor/jsdoc/app/frame/Reflection.js +26 -0
  78. data/vendor/jsdoc/app/frame/String.js +93 -0
  79. data/vendor/jsdoc/app/frame/Testrun.js +129 -0
  80. data/vendor/jsdoc/app/handlers/FOODOC.js +26 -0
  81. data/vendor/jsdoc/app/handlers/XMLDOC.js +26 -0
  82. data/vendor/jsdoc/app/handlers/XMLDOC/DomReader.js +159 -0
  83. data/vendor/jsdoc/app/handlers/XMLDOC/XMLDoc.js +16 -0
  84. data/vendor/jsdoc/app/handlers/XMLDOC/XMLParse.js +292 -0
  85. data/vendor/jsdoc/app/lib/JSDOC.js +106 -0
  86. data/vendor/jsdoc/app/lib/JSDOC/DocComment.js +204 -0
  87. data/vendor/jsdoc/app/lib/JSDOC/DocTag.js +294 -0
  88. data/vendor/jsdoc/app/lib/JSDOC/JsDoc.js +140 -0
  89. data/vendor/jsdoc/app/lib/JSDOC/JsPlate.js +109 -0
  90. data/vendor/jsdoc/app/lib/JSDOC/Lang.js +144 -0
  91. data/vendor/jsdoc/app/lib/JSDOC/Parser.js +146 -0
  92. data/vendor/jsdoc/app/lib/JSDOC/PluginManager.js +33 -0
  93. data/vendor/jsdoc/app/lib/JSDOC/Symbol.js +644 -0
  94. data/vendor/jsdoc/app/lib/JSDOC/SymbolSet.js +243 -0
  95. data/vendor/jsdoc/app/lib/JSDOC/TextStream.js +41 -0
  96. data/vendor/jsdoc/app/lib/JSDOC/Token.js +18 -0
  97. data/vendor/jsdoc/app/lib/JSDOC/TokenReader.js +332 -0
  98. data/vendor/jsdoc/app/lib/JSDOC/TokenStream.js +133 -0
  99. data/vendor/jsdoc/app/lib/JSDOC/Util.js +32 -0
  100. data/vendor/jsdoc/app/lib/JSDOC/Walker.js +507 -0
  101. data/vendor/jsdoc/app/main.js +111 -0
  102. data/vendor/jsdoc/app/plugins/commentSrcJson.js +20 -0
  103. data/vendor/jsdoc/app/plugins/frameworkPrototype.js +16 -0
  104. data/vendor/jsdoc/app/plugins/functionCall.js +10 -0
  105. data/vendor/jsdoc/app/plugins/publishSrcHilite.js +62 -0
  106. data/vendor/jsdoc/app/plugins/symbolLink.js +10 -0
  107. data/vendor/jsdoc/app/plugins/tagParamConfig.js +31 -0
  108. data/vendor/jsdoc/app/plugins/tagSynonyms.js +43 -0
  109. data/vendor/jsdoc/app/run.js +297 -0
  110. data/vendor/jsdoc/app/t/TestDoc.js +144 -0
  111. data/vendor/jsdoc/app/t/runner.js +13 -0
  112. data/vendor/jsdoc/app/test.js +342 -0
  113. data/vendor/jsdoc/app/test/addon.js +24 -0
  114. data/vendor/jsdoc/app/test/anon_inner.js +14 -0
  115. data/vendor/jsdoc/app/test/augments.js +31 -0
  116. data/vendor/jsdoc/app/test/augments2.js +26 -0
  117. data/vendor/jsdoc/app/test/borrows.js +46 -0
  118. data/vendor/jsdoc/app/test/borrows2.js +23 -0
  119. data/vendor/jsdoc/app/test/config.js +22 -0
  120. data/vendor/jsdoc/app/test/constructs.js +18 -0
  121. data/vendor/jsdoc/app/test/encoding.js +10 -0
  122. data/vendor/jsdoc/app/test/encoding_other.js +12 -0
  123. data/vendor/jsdoc/app/test/event.js +54 -0
  124. data/vendor/jsdoc/app/test/exports.js +14 -0
  125. data/vendor/jsdoc/app/test/functions_anon.js +39 -0
  126. data/vendor/jsdoc/app/test/functions_nested.js +33 -0
  127. data/vendor/jsdoc/app/test/global.js +13 -0
  128. data/vendor/jsdoc/app/test/globals.js +25 -0
  129. data/vendor/jsdoc/app/test/ignore.js +10 -0
  130. data/vendor/jsdoc/app/test/inner.js +16 -0
  131. data/vendor/jsdoc/app/test/jsdoc_test.js +477 -0
  132. data/vendor/jsdoc/app/test/lend.js +33 -0
  133. data/vendor/jsdoc/app/test/memberof.js +19 -0
  134. data/vendor/jsdoc/app/test/memberof2.js +38 -0
  135. data/vendor/jsdoc/app/test/memberof3.js +33 -0
  136. data/vendor/jsdoc/app/test/memberof_constructor.js +17 -0
  137. data/vendor/jsdoc/app/test/module.js +17 -0
  138. data/vendor/jsdoc/app/test/multi_methods.js +25 -0
  139. data/vendor/jsdoc/app/test/name.js +19 -0
  140. data/vendor/jsdoc/app/test/namespace_nested.js +23 -0
  141. data/vendor/jsdoc/app/test/nocode.js +13 -0
  142. data/vendor/jsdoc/app/test/oblit_anon.js +20 -0
  143. data/vendor/jsdoc/app/test/overview.js +20 -0
  144. data/vendor/jsdoc/app/test/param_inline.js +37 -0
  145. data/vendor/jsdoc/app/test/params_optional.js +8 -0
  146. data/vendor/jsdoc/app/test/prototype.js +17 -0
  147. data/vendor/jsdoc/app/test/prototype_nested.js +9 -0
  148. data/vendor/jsdoc/app/test/prototype_oblit.js +13 -0
  149. data/vendor/jsdoc/app/test/prototype_oblit_constructor.js +24 -0
  150. data/vendor/jsdoc/app/test/public.js +10 -0
  151. data/vendor/jsdoc/app/test/scripts/code.js +5 -0
  152. data/vendor/jsdoc/app/test/scripts/notcode.txt +5 -0
  153. data/vendor/jsdoc/app/test/shared.js +42 -0
  154. data/vendor/jsdoc/app/test/shared2.js +2 -0
  155. data/vendor/jsdoc/app/test/shortcuts.js +22 -0
  156. data/vendor/jsdoc/app/test/static_this.js +13 -0
  157. data/vendor/jsdoc/app/test/synonyms.js +31 -0
  158. data/vendor/jsdoc/app/test/tosource.js +23 -0
  159. data/vendor/jsdoc/app/test/variable_redefine.js +14 -0
  160. data/vendor/jsdoc/changes.txt +127 -0
  161. data/vendor/jsdoc/conf/sample.conf +31 -0
  162. metadata +240 -0
@@ -0,0 +1,24 @@
1
+ String.prototype.reverse = function() {
2
+ }
3
+
4
+ String.prototype.reverse.utf8 = function() {
5
+ }
6
+
7
+ Function.count = function() {
8
+ }
9
+
10
+ /** @memberOf Function */
11
+ Function.count.reset = function() {
12
+ }
13
+
14
+ /** @memberOf Function */
15
+ count.getValue = function() {
16
+ }
17
+
18
+ /** @memberOf Function.prototype */
19
+ getSig = function() {
20
+ }
21
+
22
+ /** @memberOf Function.prototype */
23
+ Function.prototype.getProps = function() {
24
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @name bar
3
+ * @namespace
4
+ */
5
+
6
+ new function() {
7
+ /**
8
+ * @name bar-foo
9
+ * @function
10
+ * @param {number} x
11
+ */
12
+ function foo(x) {
13
+ }
14
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ @constructor
3
+ */
4
+ function Layout(p) {
5
+ this.init = function(p) {
6
+ }
7
+
8
+ this.getId = function() {
9
+ }
10
+
11
+ /** @type Page */
12
+ this.orientation = "landscape";
13
+ }
14
+
15
+ /**
16
+ @constructor
17
+ @augments Layout
18
+ */
19
+ function Page() {
20
+ this.reset = function(b) {
21
+ }
22
+ }
23
+
24
+ /**
25
+ @extends Page
26
+ @constructor
27
+ */
28
+ function ThreeColumnPage() {
29
+ this.init = function(resetCode) {
30
+ }
31
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ @constructor
3
+ */
4
+ function LibraryItem() {
5
+ this.reserve = function() {
6
+ }
7
+ }
8
+
9
+ /**
10
+ @constructor
11
+ */
12
+ function Junkmail() {
13
+ this.annoy = function() {
14
+ }
15
+ }
16
+
17
+ /**
18
+ @inherits Junkmail.prototype.annoy as pester
19
+ @augments ThreeColumnPage
20
+ @augments LibraryItem
21
+ @constructor
22
+ */
23
+ function NewsletterPage() {
24
+ this.getHeadline = function() {
25
+ }
26
+ }
@@ -0,0 +1,46 @@
1
+ /**
2
+ @constructor
3
+ */
4
+ function Layout(p) {
5
+ /** initilize 1 */
6
+ this.init = function(p) {
7
+ }
8
+
9
+ /** get the id */
10
+ this.getId = function() {
11
+ }
12
+
13
+ /** @type string */
14
+ this.orientation = "landscape";
15
+
16
+ function getInnerElements(elementSecretId){
17
+ }
18
+ }
19
+
20
+ /** A static method. */
21
+ Layout.units = function() {
22
+ }
23
+
24
+ /**
25
+ @constructor
26
+ @borrows Layout#orientation
27
+ @borrows Layout-getInnerElements
28
+ @borrows Layout.units
29
+ */
30
+ function Page() {
31
+ /** reset the page */
32
+ this.reset = function(b) {
33
+ }
34
+ }
35
+
36
+ /**
37
+ @constructor
38
+ @borrows Layout.prototype.orientation as this.orientation
39
+ @borrows Layout.prototype.init as #init
40
+ @inherits Page.prototype.reset as #reset
41
+ */
42
+ function ThreeColumnPage() {
43
+ /** initilize 2 */
44
+ this.init = function(p) {
45
+ }
46
+ }
@@ -0,0 +1,23 @@
1
+ // testing circular borrows
2
+
3
+ /**
4
+ @class
5
+ @borrows Bar#zop as this.my_zop
6
+ */
7
+ function Foo() {
8
+ /** this is a zip. */
9
+ this.zip = function() {}
10
+
11
+ this.my_zop = new Bar().zop;
12
+ }
13
+
14
+ /**
15
+ @class
16
+ @borrows Foo#zip as this.my_zip
17
+ */
18
+ function Bar() {
19
+ /** this is a zop. */
20
+ this.zop = function() {}
21
+
22
+ this.my_zip = new Foo().zip;
23
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * @constructor
3
+ * @param person The person.
4
+ * @param {string} person.name The person's name.
5
+ * @config {integer} age The person's age.
6
+ * @config [id=1] Optional id number to use.
7
+ * @param connection
8
+ */
9
+ function Contact(person, connection) {
10
+
11
+ }
12
+
13
+ /**
14
+ * @constructor
15
+ * @param persons
16
+ * @config {string} Father The paternal person.
17
+ * @config {string} Mother The maternal person.
18
+ * @config {string[]} Children And the rest.
19
+ */
20
+ function Family(/**Object*/persons) {
21
+
22
+ }
@@ -0,0 +1,18 @@
1
+ var Person = makeClass(
2
+ /**
3
+ @scope Person
4
+ */
5
+ {
6
+ /**
7
+ This is just another way to define a constructor.
8
+ @constructs
9
+ @param {string} name The name of the person.
10
+ */
11
+ initialize: function(name) {
12
+ this.name = name;
13
+ },
14
+ say: function(message) {
15
+ return this.name + " says: " + message;
16
+ }
17
+ }
18
+ );
@@ -0,0 +1,10 @@
1
+
2
+ /**
3
+ * @Constructor
4
+ * @desc 配置文件
5
+ * @class 什么也不返回
6
+ */
7
+ function Test(conf) {
8
+ // do something;
9
+ }
10
+
@@ -0,0 +1,12 @@
1
+
2
+ /**
3
+ * @Constructor
4
+ * @desc ����
5
+ * @class ����������������� �����������
6
+ */
7
+ function Test(conf) {
8
+ // do something;
9
+ }
10
+
11
+ // run with commanline option -e=iso-8859-5
12
+
@@ -0,0 +1,54 @@
1
+ /**
2
+ * @name Kitchen
3
+ * @constructor
4
+ * @fires Bakery#event:donutOrdered
5
+ */
6
+
7
+ /**
8
+ * Fired when some cake is eaten.
9
+ * @name Kitchen#event:cakeEaten
10
+ * @function
11
+ * @param {Number} pieces The number of pieces eaten.
12
+ */
13
+
14
+ /**
15
+ * Find out if cake was eaten.
16
+ * @name Kitchen#cakeEaten
17
+ * @function
18
+ * @param {Boolean} wasEaten
19
+ */
20
+
21
+ /**
22
+ * @name getDesert
23
+ * @function
24
+ * @fires Kitchen#event:cakeEaten
25
+ */
26
+
27
+ /**
28
+ * @name Bakery
29
+ * @constructor
30
+ * @extends Kitchen
31
+ */
32
+
33
+ /**
34
+ * Fired when a donut order is made.
35
+ * @name Bakery#event:donutOrdered
36
+ * @event
37
+ * @param {Event} e The event object.
38
+ * @param {String} [e.topping] Optional sprinkles.
39
+ */
40
+
41
+ /**
42
+ * @constructor
43
+ * @borrows Bakery#event:donutOrdered as this.event:cakeOrdered
44
+ */
45
+ function CakeShop() {
46
+ }
47
+
48
+ /** @event */
49
+ CakeShop.prototype.icingReady = function(isPink) {
50
+ }
51
+
52
+ /** @event */
53
+ function amHungry(/**Boolean*/enoughToEatAHorse) {
54
+ }
@@ -0,0 +1,14 @@
1
+ /** @namespace */
2
+ var mxn = {};
3
+
4
+ (function(){
5
+ /** @exports Map as mxn.Map */
6
+ var Map =
7
+ /** @constructor */
8
+ mxn.Map = function() {
9
+ };
10
+
11
+ /** A method. */
12
+ Map.prototype.doThings = function() {
13
+ };
14
+ })();
@@ -0,0 +1,39 @@
1
+ /** an anonymous constructor executed inline */
2
+ a = new function() {
3
+ /** a.b*/
4
+ this.b = 1;
5
+ /** a.f */
6
+ this.f = function() {
7
+ /** a.c */
8
+ this.c = 2;
9
+ }
10
+ }
11
+
12
+
13
+ /**
14
+ named function executed inline
15
+ */
16
+ bar1 = function Zoola1() {
17
+ /** property of global */
18
+ this.g = 1;
19
+ }();
20
+
21
+ /**
22
+ named constructor executed inline
23
+ */
24
+ bar2 = new function Zoola2() {
25
+ /** property of bar */
26
+ this.p = 1;
27
+ };
28
+
29
+ /** module pattern */
30
+ module = (function () {
31
+ /** won't appear in documentation */
32
+ var priv = 1;
33
+
34
+ /** @scope module */
35
+ return {
36
+ /** will appear as a property of module */
37
+ pub: 1
38
+ }
39
+ })();
@@ -0,0 +1,33 @@
1
+ /** @constructor */
2
+ function Zop() {
3
+ }
4
+
5
+ /**
6
+ @class
7
+ */
8
+ Foo = function(id) {
9
+ // this is a bit twisted, but if you call Foo() you will then
10
+ // modify Foo(). This is kinda, sorta non-insane, because you
11
+ // would have to call Foo() 100% of the time to use Foo's methods
12
+ Foo.prototype.methodOne = function(bar) {
13
+ alert(bar);
14
+ };
15
+
16
+ // same again
17
+ Foo.prototype.methodTwo = function(bar2) {
18
+ alert(bar2);
19
+ };
20
+
21
+ // and these are only executed if the enclosing function is actually called
22
+ // and who knows if that will ever happen?
23
+ Bar = function(pez) {
24
+ alert(pez);
25
+ };
26
+ Zop.prototype.zap = function(p){
27
+ alert(p);
28
+ };
29
+
30
+ // but this is only visible inside Foo
31
+ function inner() {
32
+ }
33
+ };
@@ -0,0 +1,13 @@
1
+ /** ecks */
2
+ var x = [1, 2, 4];
3
+
4
+ var y = {
5
+ foo: function(){
6
+ }
7
+ }
8
+
9
+ bar = function() {
10
+ }
11
+
12
+ function zop() {
13
+ }
@@ -0,0 +1,25 @@
1
+ function example(/**Circle*/a, b) {
2
+ /** a global defined in function */
3
+ var number = a;
4
+
5
+ var hideNumber = function(){
6
+ }
7
+
8
+ setNumber = function(){
9
+ }
10
+ alert('You have chosen: ' + b);
11
+ }
12
+
13
+ function initPage() {
14
+ var supported = document.createElement && document.getElementsByTagName;
15
+ if (!supported) return;
16
+ // start of DOM script
17
+ var x = document.getElementById('writeroot');
18
+ // etc.
19
+ }
20
+
21
+ /** an example var */
22
+ var document = new Document(x, y);
23
+
24
+ var getNumber = function(){
25
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * A test constructor.
3
+ * @constructor
4
+ * @ignore
5
+ */
6
+ function Ignored() {
7
+ /** a method */
8
+ this.bar = function() {
9
+ }
10
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @constructor
3
+ */
4
+ function Outer() {
5
+ /**
6
+ * @constructor
7
+ */
8
+ function Inner(name) {
9
+ /** The name of this. */
10
+ this.name = name;
11
+ }
12
+
13
+ this.open = function(name) {
14
+ return (new Inner(name));
15
+ }
16
+ }