node.tags
node-module, .\src\tags.jsthis parses the "tags"
these are the first symbols of each line in a documentation-comment
- Functions
- private tags['*'](obj, line)
parses all lines beginning with
*
*
means description ( includingref
anddesc
)- Parameter
- private tags['>'](obj, line)
parses all lines beginning with
>
>
means a tag, all following lines with-
(or|
in case of Usage) are associated to it- Parameter
- private tags['|'](obj, line)
parses all lines beginning with
|
|
means usage of the documented element- Parameter
- private tags['-'](obj, line, inherit)
parses all lines beginning with
-
-
means an option and is associated to a tag tags['>']optionParamLine- Parameter
- private tags['='](obj, line, inherit)
parses all lines beginning with
=
=
means return values similar to-
tags['-']optionParamLine- Parameter
- private tags['#'](obj, line)
parses all lines beginning with
#
#
means dependency- Parameter
- private tags['!'](obj, line)
parses all lines beginning with
!
!
means author- Parameter
- private optionParamLine(line, avoidName)
parses lines that are "option"-lines
these are usually used in
-
and=
- Parameter
- Returns
- private prettify(desc)
transforms
`
,*
and_
parses the description of a function or module it transforms those to code, strong and em
`foo` == <code>foo</code>
*foo* == <strong>foo</strong>
_foo_ == <em>foo</strong>- Parameter
- Returns
- Usage
var myCodeString = codify(myString);
- private generateValids(valids)
generates all valids with type
walks through the array of valid values and checks the for a keyword keywordChecker
- Parameter
- Returns
- Usage
var obj = generateValids("['foo', true]");
- private keywordChecker(text)
checks if a string matches a javascript keyword
- Parameter
- Returns
- Usage
var type = keywordChecker('true'); // returns boolean
- public parseLine(obj, line)
parses the given line
- Parameter
- Usage
var tags = require('tags')