Class: Method
Defined in: | src/nodes/method.coffee |
Inherits: | Node |
Overview
A CoffeeScript method
Instance Method Summary
- .constructor(entity, node, lineMapping, options, comment) Constructor Construct a method @param [Class] entity the methods class @param [Object] node the node @param [Object] options the parser options @param [Object] comment the comment 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) Source
Construct a method
@param [Class] entity the methods class @param [Object] node the node @param [Object] options the parser options @param [Object] comment the comment node
Instance Method Details
.getDoc() Source
Get the class doc
@return [Doc] the class doc
Number .getLocation() Source
Get the source line number
.getName() Source
Get the method name
@return [String] the method name
.getParameters() Source
Get the method parameters
@param [Array
.getShortSignature() Source
Get the short method signature.
@return [String] the short signature
.getSignature() Source
Get the full method signature.
@return [String] the signature
.getType() Source
Get the method type, either class
or instance
@return [String] the method type
.toJSON() Source
Get a JSON representation of the object
@return [Object] the JSON object