node.doku

starts documentation on the files

Properties

version

• string

the version of the module

Standard'0.2.0'

Functions

public parse(files, out)

parses the passed files

iterates over the files, starts the file-parser, and starts the markup-generation when done. parseFile

Parameter

files

• array

the array of file-path's to document

out

• string

the folder to output to

public parseFile(text, fileName)

parses a single file

greps all the comments and calls the commentparser for each comment parseComment

Parameter

text

• string

the string to parse ( in most cases the content of a file)

(opt.) fileName

• string

the name of the file to parse

Returns

 

• array

an array holding the comments

public parseComment(comment)

parses a comment and generates an object for the tags and lines

Parameter

comment

• string

the comment to parse

Returns

 

• object

the result of the parsing

Usage

 var doku = require('doku');