Class: Referencer
Defined in: | src/util/referencer.coffee |
Overview
Responsible for resolving class references.
Class Method Summary
Instance Method Summary
- .constructor(classes, mixins, options) Constructor Construct a referencer.
- Array .getConcernMethods(clazz) Get all concerns methods.
- Array .getDirectSubClasses(clazz) Get all direct subclasses.
- Array .getExtendedMethods(clazz) Get all extended mixins in the class hierarchy.
- Array .getIncludedMethods(clazz) Get all included mixins in the class hierarchy.
- Array .getInheritedConstants(clazz) Get all inherited constants.
- .getInheritedMethods(clazz) Get all inherited methods.
- Array .getInheritedProperties(clazz) Get all inherited properties.
- Array .getInheritedVariables(clazz) Get all inherited variables.
- .getLink(classname, path) Get the link to classname.
- String .linkType(text = '', path) Create browsable links to a known entity.
- String .linkTypes(text = '', path) Creates browsable links for known entities.
- Object .readStandardJSON() Constructs the documentation links for the standard JS objects.
- .resolveDelegation(origin, ref, entity) Resolves delegations; that is, methods whose source content come from These are basically conrefs.
- Object .resolveDoc(data, entity, path) Resolve all tags on class and method json output.
- Array .resolveMixinMethods(name) Get a list of all methods from the given mixin name
- .resolveParamReferences() Resolve parameter references.
- Object .resolveSee(see, entity, path) Resolves curly-bracket reference links.
- .resolveTextReferences(text = '', entity, path) Search a text to find see links wrapped in curly braces.
- Boolean .verifyExternalObjReference(name) Checks to make sure that an object that's referenced exists in standardObjs.json.
Class Method Details
@getLinkMatch(text)
Constructor Details
.constructor(classes, mixins, options)
Construct a referencer.
Instance Method Details
Array .getConcernMethods(clazz)
Get all concerns methods.
Array .getDirectSubClasses(clazz)
Get all direct subclasses.
Array .getExtendedMethods(clazz)
Get all extended mixins in the class hierarchy.
Array .getIncludedMethods(clazz)
Get all included mixins in the class hierarchy.
Array .getInheritedConstants(clazz)
Get all inherited constants.
.getInheritedMethods(clazz)
Get all inherited methods.
Array .getInheritedProperties(clazz)
Get all inherited properties.
Array .getInheritedVariables(clazz)
Get all inherited variables.
.getLink(classname, path)
Get the link to classname.
See {::linkTypes}.
String .linkType(text = '', path)
Create browsable links to a known entity.
See {::getLink}.
String .linkTypes(text = '', path)
Creates browsable links for known entities.
See {::getLink}.
Object .readStandardJSON()
Constructs the documentation links for the standard JS objects.
.resolveDelegation(origin, ref, entity)
Resolves delegations; that is, methods whose source content come from
These are basically conrefs.
Object .resolveDoc(data, entity, path)
Resolve all tags on class and method json output.
Array .resolveMixinMethods(name)
Get a list of all methods from the given mixin name
.resolveParamReferences()
Resolve parameter references. This goes through all
Object .resolveSee(see, entity, path)
Resolves curly-bracket reference links.
.resolveTextReferences(text = '', entity, path)
Search a text to find see links wrapped in curly braces.
Examples:
Boolean .verifyExternalObjReference(name)
Checks to make sure that an object that's referenced exists in standardObjs.json.