Class DocBuilder
Class defined in:lib/builder.js:9
Takes the JSON
data from the DocParser
class, creates and parses markdown and handlebars
based templates to generate static HTML content
_inlineCode
( html
) /* private method */
lib/builder.js:440
Ported from Selleck, this handles `
's in fields
that are not parsed by the Markdown parser.
-
html
<HTML> The HTML to parse
_parseCode
( html
) /* private method */
lib/builder.js:429
Parses <pre><code>
tags and adds the prettyprint className
to them
-
html
<HTML> The HTML to parse
augmentData
( o
)
lib/builder.js:348
Augments the DocParser meta data to provide default values for certain keys as well as parses all descriptions
with the Markdown Parser
-
o
<Object> The object to recurse and augment
compile
( cb
)
lib/builder.js:897
Compiles the templates from the meta-data provided by DocParser
Parameters:-
cb
<Callback> The callback to execute after it's completed
filterFileName
( f
)
lib/builder.js:884
Normalizes a file path to a writable filename:
var path = 'lib/file.js';
returns 'lib_file.js';
Parameters:
-
f
<String> The filename to normalize
getProjectMeta
(
)
lib/builder.js:239
Prep the meta data to be fed to Selleck
makeDirs
( cb
)
lib/builder.js:405
Makes the default directories needed
Parameters:-
cb
<Callback> The callback to execute after it's completed
nameSort
( a, b
)
lib/builder.js:815
Sort method of array of objects with a property called name
Parameters:populateClasses
( opts
)
lib/builder.js:257
Populate the meta data for classes
Parameters:-
opts
<Object> The original options
populateFiles
( opts
)
lib/builder.js:294
Populate the meta data for files
Parameters:-
opts
<Object> The original options
populateModules
( opts
)
lib/builder.js:271
Populate the meta data for modules
Parameters:-
opts
<Object> The original options
render
( source, view, [layout=null], [partials={}], callback
)
lib/builder.js:459
Ported from Selleck Renders the handlebars templates with the default View class.
Parameters:writeClasses
( cb
)
lib/builder.js:642
Generates the class files under "out"/classes/
Parameters:-
cb
<Callback> The callback to execute after it's completed
writeFiles
( cb
)
lib/builder.js:838
Generates the syntax files under "out"/files/
-
cb
<Callback> The callback to execute after it's completed
writeIndex
( cb
)
lib/builder.js:509
Generates the index.html file
Parameters:-
cb
<Callback> The callback to execute after it's completed
writeModules
( cb
)
lib/builder.js:535
Generates the module files under "out"/modules/
Parameters:-
cb
<Callback> The callback to execute after it's completed
defaultTags
<String>lib/builder.js:227
The default tags to use in params descriptions (for Markdown).