Class: Referencer

Defined in: src/util/referencer.coffee

Overview

Class reference resolver.

Class Method Summary

Instance Method Summary

Class Method Details

@getLinkMatch(text) Source

Constructor Details

.constructor(classes, mixins, options) Source

Construct a referencer.

Parameters:

  • classesAll known classes
  • mixinsAll known mixins
  • optionsthe parser options (a [Object])

Instance Method Details

.getConcernMethods(clazz) Source

Get all concerns

Parameters:

  • clazzthe class (a [Class])

Returns:

  • Returns the concerns (a [Object])

.getDirectSubClasses(clazz) Source

Get all direct subclasses.

Parameters:

  • clazzthe parent class (a [Class])

Returns:

  • Returns the classes

.getExtendedMethods(clazz) Source

Get all extended mixins in the class hierarchy.

Parameters:

  • clazzthe class (a [Class])

Returns:

  • Returns the mixins (a [Object])

.getIncludedMethods(clazz) Source

Get all included mixins in the class hierarchy.

Parameters:

  • clazzthe class (a [Class])

Returns:

  • Returns the mixins (a [Object])

.getInheritedConstants(clazz) Source

Get all inherited constants.

Parameters:

  • clazzthe parent class (a [Class])

Returns:

  • Returns the constants

.getInheritedMethods(clazz) Source

Get all inherited methods.

Parameters:

  • clazzthe parent class (a [Class])

Returns:

  • Returns the classes

.getInheritedProperties(clazz) Source

Get all inherited properties.

Parameters:

  • clazzthe parent class (a [Class])

Returns:

  • Returns the properties

.getInheritedVariables(clazz) Source

Get all inherited variables.

Parameters:

  • clazzthe parent class (a [Class])

Returns:

  • Returns the variables

Get the link to classname.

See {#linkTypes}.

Parameters:

  • classnamethe class name (a [String])
  • paththe path prefix (a [String])

Returns:

  • Returns the link (if any)

.linkType(text = '', path) Source

Create browsable links to a known entity.

See {#getLink}.

Parameters:

  • (String) textthe text to parse. (a {String})
  • (Number string string string.) paththe path prefix (a {Number string string string.})

Returns:

  • Returns the processed text (a [String])

.linkTypes(text = '', path) Source

Create browsable links for known entities.

See {#getLink}.

Parameters:

  • textthe text to parse. (a [String])
  • paththe path prefix (a [String])

Returns:

  • Returns the processed text (a [String])

.readStandardJSON() Source

.resolveDelegation(origin, ref, entity) Source

Resolves delegations; that is, methods whose source content come from

Conrefs, basically.

.resolveDoc(data, entity, path) Source

Resolve all tags on class and method json output.

Parameters:

  • datathe json data (a [Object])
  • entitythe entity context (a [Class])
  • paththe path to the asset root (a [String])

Returns:

  • Returns the json data with resolved references (a [Object])

.resolveMixinMethods(name) Source

Get a list of all methods from the given mixin name

Parameters:

  • nameThe full name of the mixin

Returns:

  • Returns the mixin methods

.resolveParamReferences() Source

Resolve parameter references. This goes through all

.resolveSee(see, entity, path) Source

Resolves curly-bracket reference links.

Parameters:

  • seethe reference object (a [Object])
  • entitythe entity context (a [Class])
  • paththe path to the asset root (a [String])

Returns:

  • Returns the resolved see (a [Object])

.resolveTextReferences(text = '', entity, path) Source

Search a text to find see links wrapped in curly braces.

Examples:

.verifyExternalObjReference(name) Source