Class: Method

Defined in: src/nodes/method.coffee
Inherits: Node

Overview

The Node representation of a CoffeeScript method.

Instance Method Summary

Inherited Method Summary

Methods inherited from Node

.findAncestor

Constructor Details

.constructor(entity, node, lineMapping, options, comment)

Constructs the documentation node.

Parameters:

  • (Class) entityThe method's Class
  • (Object) nodeThe method node (a {Object})
  • (String) fileNameThe filename (a {String})
  • lineMappingAn object mapping the actual position of a member to its Biscotto one
  • (Object) optionsThe parser options (a {Object})
  • (Object) commentThe comment node (a {Object})

Instance Method Details

.getDoc()

Get the class doc

@return [Doc] the class doc

Number .getLocation()

Get the source line number

Returns:

  • (Number) — Returns a {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.

@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