Class: Doc
Defined in: | src/nodes/doc.coffee |
Inherits: | Node |
Overview
A documentation node is responsible for parsing
Instance Method Summary
- .constructor(node, options) Constructor Construct a documentation
- .deindent(lines)
- .hasComment() Determines if the current doc has some comments
- .leftTrimBlock(lines) Detect whitespace on the left and removes
- .parseBlock(lines) Parse the given lines as TomDoc and adds the result
- .parse_arguments(section) Parse arguments section.
- .parse_description(section) Parse description.
- .parse_examples(section, sections) Parse examples.
- .parse_returns(section) Parse returns section.
- .toJSON() Get a JSON representation of the object
Inherited Method Summary
Methods inherited from Node
Constructor Details
.constructor(node, options) Source
Construct a documentation
Instance Method Details
.deindent(lines) Source
.hasComment() Source
Determines if the current doc has some comments
.leftTrimBlock(lines) Source
Detect whitespace on the left and removes
Examples:
.parseBlock(lines) Source
Parse the given lines as TomDoc and adds the result
.parse_arguments(section) Source
Parse arguments section. Arguments occur subsequent to
.parse_description(section) Source
Parse description.
.parse_examples(section, sections) Source
Parse examples.
.parse_returns(section) Source
Parse returns section.
.toJSON() Source
Get a JSON representation of the object