Class: Method
Defined in: | src/nodes/method.coffee |
Inherits: | Node |
Overview
The Node representation of a CoffeeScript method.
Instance Method Summary
- .constructor(entity, node, lineMapping, options, comment) Constructor Constructs the documentation node.
- .getDoc() Get the class doc @return [Doc] the class doc
- Number .getLocation() Get the source line number
- .getName() Get the method name @return {String} the method name
-
.getParameters()
Get the method parameters @param [Array
] the method parameters - .getShortSignature() Get the short method signature.
- .getSignature() Get the full method signature.
-
.getType()
Get the method type, either
class
orinstance
@return {String} the method type - .toJSON() Get a JSON representation of the object @return {Object} the JSON object
Inherited Method Summary
Methods inherited from Node
Constructor Details
.constructor(entity, node, lineMapping, options, comment)
Constructs the documentation node.
Instance Method Details
.getDoc()
Get the class doc
@return [Doc] the class doc
Number .getLocation()
Get the source line number
.getName()
Get the method name
@return {String} the method name
.getParameters()
Get the method parameters
@param [Array
.getShortSignature()
Get the short method signature.
@return {String} the short signature
.getSignature()
Get the full method signature.
@return {String} the signature
.getType()
Get the method type, either class
or instance
@return {String} the method type
.toJSON()
Get a JSON representation of the object
@return {Object} the JSON object