UNPKG

jsduckify

Version:

Enables the use of Sencha's JSDuck for documenting CoffeeScript projects.

github.com/lmaccherone/jsduckify

lmaccherone/jsduckify

68 lines (59 loc) • 2.26 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>The source code</title> <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" /> <script type="text/javascript" src="../resources/prettify/prettify.js"></script> <style type="text/css"> .highlight { display: block; background-color: #ddd; } </style> <script type="text/javascript"> function highlight() { document.getElementById(location.hash.replace(/#/, "")).className = "highlight"; } </script> </head> <body onload="prettyPrint(); highlight();"> <pre class="prettyprint lang-js">/* &lt;CoffeeScript&gt; duckifyFile = require(&#39;./duckifyFile&#39;).duckifyFile {DoublyLinkedList} = require(&#39;doubly-linked-list&#39;) &lt;/CoffeeScript&gt; */ <span id='jsduckify-method-buildMainFile'>/** </span> * @method buildMainFile * @member jsduckify * * @param {String} filename * @param {String} readmeString * @param {String} mainSourceString CoffeeScript source * @param {Array} exportsAPI each row contains {baseName, fullName, type} * @param {String} prefix the root for this documentation * * @return {String} duckifiedMainFile */ /* &lt;CoffeeScript&gt; exports.buildMainFile = (filename, readmeString, mainSourceString, exportsAPI, prefix) -&gt; # Breaks the file down into lines. lineList = new DoublyLinkedList(mainSourceString.split(&#39;\n&#39;)) unless lineList.head.value.indexOf(&#39;###&#39;) == 0 # Starts with a DocString. Make it the Main. lineList.head.insertBefore(&#39;###&#39;) lineList.head.insertBefore(&#39;###&#39;) lineList.head.insertAfter(readmeString) lineList.head.insertAfter(&quot;@class #{prefix}&quot;) sourceFileString = lineList.toArray().join(&#39;\n&#39;) # sourceFileString = &quot;&quot;&quot; # ### # @class #{prefix} # @extends # #{readmeString} # ### # #{mainSourceString} # &quot;&quot;&quot; for e in exportsAPI unless e.processed? console.log(&quot;Couldn&#39;t find #{e.fullName} in source.&quot;) duckifiedMainFile = duckifyFile(filename, sourceFileString, exportsAPI, prefix = &#39;&#39;, true) return duckifiedMainFile &lt;/CoffeeScript&gt; */</pre> </body> </html>