Class: Referencer

Defined in: src/util/referencer.coffee

Overview

Responsible for resolving class references.

Instance Method Summary

Constructor Details

::constructor(classes, mixins, options) Source

Construct a referencer.

Parameters:

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

Instance Method Details

Array ::getConcernMethods(clazz) Source

Get all concerns methods.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Array ::getDirectSubClasses(clazz) Source

Get all direct subclasses.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Array ::getExtendedMethods(clazz) Source

Get all extended mixins in the class hierarchy.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Array ::getIncludedMethods(clazz) Source

Get all included mixins in the class hierarchy.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Array ::getInheritedConstants(clazz) Source

Get all inherited constants.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

::getInheritedMethods(clazz) Source

Get all inherited methods.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

  • Returns the inherited methods.

Array ::getInheritedProperties(clazz) Source

Get all inherited properties.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Array ::getInheritedVariables(clazz) Source

Get all inherited variables.

Parameters:

  • (Class) clazzThe parent class (a Class)

Returns:

Get the link to classname.

See ::linkTypes.

Parameters:

  • (String) classnameThe class name (a String)
  • (String) pathThe path prefix (a String)

Returns:

  • Returns the link (if any)

String ::linkType(text = '', path) Source

Create browsable links to a known entity.

See ::getLink.

Parameters:

  • (String) textThe text to parse (a String)
  • (String) pathThe path prefix (a String)

Returns:

  • (String) — Returns the processed text (a String)

String ::linkTypes(text = '', path) Source

Creates browsable links for known entities.

See ::getLink.

Parameters:

  • (String) textThe text to parse (a String)
  • (String) pathThe path prefix (a String)

Returns:

  • (String) — Returns the processed text (a String)

Object ::readStandardJSON() Source

Constructs the documentation links for the standard JS objects.

Returns:

  • (Object) — Returns a JSON Object.

::resolveDelegation(origin, ref, entity) Source

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

These are basically conrefs.

Object ::resolveDoc(data, entity, path) Source

Resolve all tags on class and method json output.

Parameters:

  • (Object) dataThe JSON data (a Object)
  • (Class) entityThe entity context (a Class)
  • (String) pathThe path to the asset root (a String)

Returns:

  • (Object) — Returns the JSON data with resolved references (a Object)

Array ::resolveMixinMethods(name) Source

Get a list of all methods from the given mixin name

Parameters:

  • (Mixin) nameThe full name of the Mixin

Returns:

  • (Array) — Returns the mixin methods as an Array.

::resolveParamReferences() Source

Resolve parameter references. This goes through all method parameter and see if a param doc references another method. If so, copy over the doc meta data.

Object ::resolveSee(see, entity, path) Source

Resolves curly-bracket reference links.

Parameters:

  • (Object) seeThe reference object (a Object)
  • (Class) entityThe entity context (a Class)
  • (String) pathThe path to the asset root (a String)

Returns:

  • (Object) — Returns the resolved see (a Object).

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

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

Examples:

Boolean ::verifyExternalObjReference(name) Source

Checks to make sure that an object that's referenced exists in standardObjs.json.

Returns: