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
data/lib/sc_docs/templates/docs.sproutcore.com/class.tmpl ADDED
@@ -0,0 +1,437 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>SproutCore</title>
6
+ <meta name="description" content="A framework for building fast, desktop caliber web applications." />
7
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
8
+ <link rel="stylesheet" href="/css/api.css" />
9
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
10
+ <script src="/js/jquery-bbq.js"></script>
11
+ <script src="/js/api.js"></script>
12
+ <script src="/js/lib/modernizr-1.7.min.js"></script>
13
+ <!--[if lt IE 9]>
14
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
15
+ <![endif]-->
16
+ </head>
17
+
18
+ <body id="docs">
19
+ <!-- ============================== header ================================= -->
20
+ <!-- begin static/header.html -->
21
+ {+include("static/header.html")+}
22
+ <!-- end static/header.html -->
23
+
24
+ <!-- ============================== classes index ============================ -->
25
+
26
+ <section id="list">
27
+ <header>
28
+ <form action="#" role="search">
29
+ <input type="text" />
30
+ <a href="#" class="search-reset"></a>
31
+ </form>
32
+ </header>
33
+ <div>
34
+ {+publish.classesIndex+}
35
+ </div>
36
+ </section>
37
+ <footer>
38
+ <a href="http://groups.google.com/group/sproutcore" class="button secondary">SUBSCRIBE TO MAILING LIST</a>
39
+ </footer>
40
+
41
+ <div role="main">
42
+ <section id="documentation">
43
+ <!-- ============================== class title ============================ -->
44
+ <h1 class="classTitle">
45
+ {!
46
+ var classType = "";
47
+
48
+ if (data.isBuiltin()) {
49
+ classType += "Built-In ";
50
+ }
51
+
52
+ if (data.isNamespace) {
53
+ if (data.is('FUNCTION')) {
54
+ classType += "Function: ";
55
+ }
56
+ classType += "Namespace: ";
57
+ }
58
+ else {
59
+ classType += "Class: ";
60
+ }
61
+ !}
62
+ {+classType+}{+data.alias+}
63
+ </h1>
64
+
65
+ <!-- ============================== class summary ========================== -->
66
+ <p class="description">
67
+ <span class="extends">
68
+ <if test="data.augments.length"><br />Extends
69
+ {+
70
+ data.augments
71
+ .sort()
72
+ .map(
73
+ function($) { return new Link().toSymbol($); }
74
+ )
75
+ .join(", ")
76
+ +}.<br />
77
+ </if>
78
+ </span>
79
+
80
+ {+data.classDesc+}
81
+
82
+ <if test="!data.isBuiltin()">{# isn't defined in any file #}
83
+ <span class="definedin">Defined in: {+new Link().toSrc(data.srcFile)+}.</span>
84
+ </if>
85
+ </p>
86
+
87
+
88
+ <!-- ============================== properties summary ===================== -->
89
+ <if test="data.properties.length">
90
+ {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
91
+ <if test="ownProperties.length">
92
+ <h2>Field Summary</h2>
93
+ <div id="properties">
94
+ <ul>
95
+ <for each="member" in="ownProperties">
96
+ <li>
97
+ <if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if>{+new Link().toSymbol(member.alias).withText(member.name)+}
98
+ </li>
99
+ </for>
100
+ </ul>
101
+ </if>
102
+
103
+ <if test="data.inheritsFrom.length">
104
+ <dl class="inheritsList">
105
+ {!
106
+ var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
107
+
108
+ var contributers = [];
109
+ borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
110
+ for (var i = 0, l = contributers.length; i < l; i++) {
111
+ output +=
112
+ "<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
113
+ +
114
+ "<dd>" +
115
+ borrowedMembers
116
+ .filter(
117
+ function($) { return $.memberOf == contributers[i] }
118
+ )
119
+ .sort(makeSortby("name"))
120
+ .map(
121
+ function($) { return new Link().toSymbol($.alias).withText($.name) }
122
+ )
123
+ .join(", ")
124
+ +
125
+ "</dd>";
126
+ }
127
+ !}
128
+ </dl>
129
+ </div>
130
+ </if>
131
+ </if>
132
+
133
+
134
+
135
+
136
+ <!-- ============================== methods summary ======================== -->
137
+ <if test="data.methods.length">
138
+ {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
139
+ <if test="ownMethods.length">
140
+ <h2>Methods</h2>
141
+ <ul class="methods">
142
+ <for each="member" in="ownMethods">
143
+ <li class="fixedFont">{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, '')) +}</li>
144
+ </for>
145
+ </ul>
146
+ </if>
147
+
148
+
149
+ </if>
150
+ <!-- ============================== events summary ======================== -->
151
+ <if test="data.events.length">
152
+ {! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
153
+ <if test="ownEvents.length">
154
+ <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}.">
155
+ <caption>Event Summary</caption>
156
+ <thead>
157
+ <tr>
158
+ <th scope="col">Event Attributes</th>
159
+ <th scope="col">Event Name and Description</th>
160
+ </tr>
161
+ </thead>
162
+ <tbody>
163
+ <for each="member" in="ownEvents">
164
+ <tr>
165
+ <td class="attributes">
166
+ </td>
167
+ <td class="nameDescription">
168
+ <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+}
169
+ </div>
170
+ <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
171
+ </td>
172
+ </tr>
173
+ </for>
174
+ </tbody>
175
+ </table>
176
+ </if>
177
+
178
+
179
+ </if>
180
+
181
+
182
+
183
+ <!-- ============================== field details ========================== -->
184
+ <if test="defined(ownProperties) && ownProperties.length">
185
+ <h2>
186
+ Field Detail
187
+ </h2>
188
+ <for each="member" in="ownProperties">
189
+ <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
190
+ <if test="member.type"><span class="light">{+new Link().toSymbol(member.type)+}</span></if>
191
+ <span class="property"><if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b></span>
192
+
193
+ <div class="description">
194
+ {+resolveLinks(member.desc)+}
195
+ <if test="member.srcFile != data.srcFile">
196
+ <br />
197
+ <span class="definedin">Defined in: </span> {+new Link().toSrc(member.srcFile)+}.
198
+ </if>
199
+ <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
200
+ </div>
201
+
202
+ <if test="member.example.length">
203
+ <for each="example" in="member.example">
204
+ <pre class="code">{+example+}</pre>
205
+ </for>
206
+ </if>
207
+
208
+ <if test="member.deprecated">
209
+ <dl class="detailList">
210
+ <dt class="heading">Deprecated:</dt>
211
+ <dt>
212
+ {+ resolveLinks(member.deprecated) +}
213
+ </dt>
214
+ </dl>
215
+ </if>
216
+ <if test="member.since">
217
+ <dl class="detailList">
218
+ <dt class="heading">Since:</dt>
219
+ <dd>{+ member.since +}</dd>
220
+ </dl>
221
+ </if>
222
+ <if test="member.see.length">
223
+ <dl class="detailList">
224
+ <dt class="heading">See:</dt>
225
+ <for each="item" in="member.see">
226
+ <dd>{+ new Link().toSymbol(item) +}</dd>
227
+ </for>
228
+ </dl>
229
+ </if>
230
+ <if test="member.defaultValue">
231
+ <dl class="detailList">
232
+ <dt class="heading">Default Value:</dt>
233
+ <dd>
234
+ {+resolveLinks(member.defaultValue)+}
235
+ </dd>
236
+ </dl>
237
+ </if>
238
+
239
+ </for>
240
+ </if>
241
+
242
+
243
+ <!-- ============================== method details ========================= -->
244
+ <if test="defined(ownMethods) && ownMethods.length">
245
+ <h2>Method Detail</h2>
246
+ <for each="member" in="ownMethods">
247
+ <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
248
+ <div class="fixedFont">
249
+
250
+ <span class="methodname">{+member.name.replace(/\^\d+$/, '')+}</span>
251
+ </div>
252
+ <div class="description">
253
+ {+resolveLinks(member.desc)+}
254
+ <if test="member.srcFile != data.srcFile">
255
+ <br />
256
+ <span class="definedin">Defined in: {+new Link().toSrc(member.srcFile)+}.</span>
257
+ </if>
258
+ <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
259
+ </div>
260
+
261
+ <if test="member.example.length">
262
+ <for each="example" in="member.example">
263
+ <pre class="code">{+example+}</pre>
264
+ </for>
265
+ </if>
266
+
267
+ <if test="member.params.length">
268
+ <dl class="parameters">
269
+ <dt class="heading">Parameters:</dt>
270
+ <for each="item" in="member.params">
271
+ <dt>
272
+ {+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
273
+ <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
274
+ </dt>
275
+ <dd>{+resolveLinks(item.desc)+}</dd>
276
+ </for>
277
+ </dl>
278
+ </if>
279
+ <if test="member.deprecated">
280
+ <dl class="detailList">
281
+ <dt class="heading">Deprecated:</dt>
282
+ <dt>
283
+ {+ resolveLinks(member.deprecated) +}
284
+ </dt>
285
+ </dl>
286
+ </if>
287
+ <if test="member.since">
288
+ <dl class="detailList">
289
+ <dt class="heading">Since:</dt>
290
+ <dd>{+ member.since +}</dd>
291
+ </dl>
292
+ </dl>
293
+ </if>
294
+ <if test="member.exceptions.length">
295
+ <dl class="detailList">
296
+ <dt class="heading">Throws:</dt>
297
+ <for each="item" in="member.exceptions">
298
+ <dt>
299
+ {+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
300
+ </dt>
301
+ <dd>{+resolveLinks(item.desc)+}</dd>
302
+ </for>
303
+ </dl>
304
+ </if>
305
+ <if test="member.returns.length">
306
+ <dl class="returns">
307
+ <dt class="heading">Returns:</dt>
308
+ <for each="item" in="member.returns">
309
+ <dd>{+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
310
+ </for>
311
+ </dl>
312
+ </if>
313
+ <if test="member.requires.length">
314
+ <dl class="detailList">
315
+ <dt class="heading">Requires:</dt>
316
+ <for each="item" in="member.requires">
317
+ <dd>{+ resolveLinks(item) +}</dd>
318
+ </for>
319
+ </dl>
320
+ </if>
321
+ <if test="member.see.length">
322
+ <dl class="detailList">
323
+ <dt class="heading">See:</dt>
324
+ <for each="item" in="member.see">
325
+ <dd>{+ new Link().toSymbol(item) +}</dd>
326
+ </for>
327
+ </dl>
328
+ </if>
329
+
330
+ </for>
331
+ </if>
332
+
333
+ <!-- ============================== event details ========================= -->
334
+ <if test="defined(ownEvents) && ownEvents.length">
335
+ <div class="sectionTitle">
336
+ Event Detail
337
+ </div>
338
+ <for each="member" in="ownEvents">
339
+ <a name="event:{+Link.symbolNameToLinkName(member)+}"> </a>
340
+ <div class="fixedFont">
341
+
342
+ <if test="member.type"><span class="light">{+new Link().toSymbol(member.type)+}</span></if>
343
+ <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
344
+
345
+ </div>
346
+ <div class="description">
347
+ {+resolveLinks(member.desc)+}
348
+ <if test="member.srcFile != data.srcFile">
349
+ <br />
350
+ <span class="definedin">Defined in: {+new Link().toSrc(member.srcFile)+}.</span>
351
+ </if>
352
+ <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
353
+ </div>
354
+
355
+ <if test="member.example.length">
356
+ <for each="example" in="member.example">
357
+ <pre class="code">{+example+}</pre>
358
+ </for>
359
+ </if>
360
+
361
+ <if test="member.params.length">
362
+ <dl class="detailList">
363
+ <dt class="heading">Parameters:</dt>
364
+ <for each="item" in="member.params">
365
+ <dt>
366
+ {+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
367
+ <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
368
+ </dt>
369
+ <dd>{+ resolveLinks(item.desc) +}</dd>
370
+ </for>
371
+ </dl>
372
+ </if>
373
+ <if test="member.deprecated">
374
+ <dl class="detailList">
375
+ <dt class="heading">Deprecated:</dt>
376
+ <dt>
377
+ {+ resolveLinks(member.deprecated) +}
378
+ </dt>
379
+ </dl>
380
+ </if>
381
+ <if test="member.since">
382
+ <dl class="detailList">
383
+ <dt class="heading">Since:</dt>
384
+ <dd>{+ member.since +}</dd>
385
+ </dl>
386
+ </dl>
387
+ </if>
388
+ <if test="member.exceptions.length">
389
+ <dl class="detailList">
390
+ <dt class="heading">Throws:</dt>
391
+ <for each="item" in="member.exceptions">
392
+ <dt>
393
+ {+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
394
+ </dt>
395
+ <dd>{+ resolveLinks(item.desc) +}</dd>
396
+ </for>
397
+ </dl>
398
+ </if>
399
+ <if test="member.returns.length">
400
+ <dl class="detailList">
401
+ <dt class="heading">Returns:</dt>
402
+ <for each="item" in="member.returns">
403
+ <dd>{+((item.type)?"<span class=\"light fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
404
+ </for>
405
+ </dl>
406
+ </if>
407
+ <if test="member.requires.length">
408
+ <dl class="detailList">
409
+ <dt class="heading">Requires:</dt>
410
+ <for each="item" in="member.requires">
411
+ <dd>{+ resolveLinks(item) +}</dd>
412
+ </for>
413
+ </dl>
414
+ </if>
415
+ <if test="member.see.length">
416
+ <dl class="detailList">
417
+ <dt class="heading">See:</dt>
418
+ <for each="item" in="member.see">
419
+ <dd>{+ new Link().toSymbol(item) +}</dd>
420
+ </for>
421
+ </dl>
422
+ </if>
423
+
424
+ </for>
425
+ </if>
426
+
427
+
428
+
429
+ <!-- ============================== footer ================================= -->
430
+ <div class="fineprint" style="clear:both">
431
+ <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
432
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
433
+ </div>
434
+ </section>
435
+ </div>
436
+ </body>
437
+ </html>
data/lib/sc_docs/templates/docs.sproutcore.com/index.tmpl ADDED
@@ -0,0 +1,52 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>SproutCore</title>
6
+ <meta name="description" content="A framework for building fast, desktop caliber web applications." />
7
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
8
+ <link rel="stylesheet" href="/css/api.css" />
9
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
10
+ <script src="/js/jquery-bbq.js"></script>
11
+ <script src="/js/api.js"></script>
12
+ <script src="/js/lib/modernizr-1.7.min.js"></script>
13
+ <!--[if lt IE 9]>
14
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
15
+ <![endif]-->
16
+ </head>
17
+
18
+ <body id="docs" class="blue">
19
+ {+include("static/header.html")+}
20
+
21
+ <section id="list">
22
+ <header>
23
+ <form action="#" role="search">
24
+ <input type="text" />
25
+ <a href="#" class="search-reset"></a>
26
+ </form>
27
+ </header>
28
+ <div>
29
+ {+publish.classesIndex+}
30
+ </div>
31
+ </section>
32
+ <footer>
33
+ <a href="http://groups.google.com/group/sproutcore" class="button secondary">SUBSCRIBE TO MAILING LIST</a>
34
+ </footer>
35
+
36
+ <div role="main">
37
+ <section id="documentation">
38
+
39
+ <h1 class="classTitle">API Documentation Index</h1>
40
+
41
+ <for each="thisClass" in="data">
42
+ <h2 class="classname">{+(new Link().toSymbol(thisClass.alias))+}</h2>
43
+ <p class="description">{+summarize(thisClass.classDesc)+}</p>
44
+ </for>
45
+ <div class="fineprint" style="clear:both">
46
+ <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
47
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
48
+ </div>
49
+ </section>
50
+ </div>
51
+ </body>
52
+ </html>