Class: Doc
Defined in: | src/nodes/doc.coffee |
Inherits: | Node |
Overview
A documentation node is responsible for parsing the comments for known tags.
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 the minimum whitespace ammount.
- ::parseBlock(lines) Parse the given lines as TomDoc and adds the result to the result object.
- ::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) Source
Construct a documentation node.
Instance Method Details
Boolean ::hasComment() Source
Determines if the current doc has some comments
Boolean ::isInternal() Source
Is this doc internal?
Boolean ::isPrivate() Source
Is this doc private?
Boolean ::isPublic() Source
Is this doc public?
::leftTrimBlock(lines) Source
Detect whitespace on the left and removes the minimum whitespace ammount.
Examples:
::parseBlock(lines) Source
Parse the given lines as TomDoc and adds the result to the result object.
::parse_arguments(section) Source
Parse the member's arguments. Arguments occur subsequent to the description.
::parse_description(section) Source
Parse the member description.
::parse_examples(section, sections) Source
Parse the member examples.
::parse_returns(section) Source
Parse the member's return values.
Object ::toJSON() Source
Get a JSON representation of the object.