UNPKG

jsduckify

Version:

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

45 lines (41 loc) 1.62 kB
<!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 &lt;/CoffeeScript&gt; */ <span id='jsduckify-method-duckifyFiles'>/** </span> * @method duckifyFiles * @member jsduckify * @param {Object} sourceFileMap key: filename, value: file as string * @param {String} prefix The root for this documentation * @param {Object} exportsAPIMap key: function/property identifier, value: full tree for this element * * @return {Object} key: filename (same as sourceFileMap), value: duckified source file as a String */ /* &lt;CoffeeScript&gt; exports.duckifyFiles = (sourceFileMap, prefix, exportsAPIMap) -&gt; duckifiedFileMap = {} # outputFiles for filename, sourceFileString of sourceFileMap duckifiedFile = duckifyFile(filename, sourceFileString, exportsAPIMap, prefix) if duckifiedFile? duckifiedFileMap[filename + &#39;.js&#39;] = duckifiedFile return duckifiedFileMap &lt;/CoffeeScript&gt; */</pre> </body> </html>