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 node.
- Boolean .hasComment() Determines if the current doc has some comments
- Boolean .isInternal() Is this doc internal?
- Boolean .isPrivate() Is this doc private?
- Boolean .isPublic() Is this doc public?
- .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 the member's arguments.
- .parse_description(section) Parse the member description.
- .parse_examples(section, sections) Parse the member examples.
- .parse_returns(section) Parse the member's return values.
- Object .toJSON() Get a JSON representation of the object.
Inherited Method Summary
Methods inherited from Node
Constructor Details
.constructor(node, options)
Construct a documentation node.
Instance Method Details
Boolean .hasComment()
Determines if the current doc has some comments
Boolean .isInternal()
Is this doc internal?
Boolean .isPrivate()
Is this doc private?
Boolean .isPublic()
Is this doc public?
.leftTrimBlock(lines)
Detect whitespace on the left and removes
Examples:
.parseBlock(lines)
Parse the given lines as TomDoc and adds the result
.parse_arguments(section)
Parse the member's arguments. Arguments occur subsequent to
.parse_description(section)
Parse the member description.
.parse_examples(section, sections)
Parse the member examples.
.parse_returns(section)
Parse the member's return values.
Object .toJSON()
Get a JSON representation of the object.