Class: Referencer
Defined in: | src/util/referencer.coffee |
Overview
Class reference resolver.
Class Method Summary
Instance Method Summary
- .constructor(classes, mixins, options) Constructor Construct a referencer.
- .getConcernMethods(clazz) Get all concerns
- .getDirectSubClasses(clazz) Get all direct subclasses.
- .getExtendedMethods(clazz) Get all extended mixins in the class hierarchy.
- .getIncludedMethods(clazz) Get all included mixins in the class hierarchy.
- .getInheritedConstants(clazz) Get all inherited constants.
- .getInheritedMethods(clazz) Get all inherited methods.
- .getInheritedProperties(clazz) Get all inherited properties.
- .getInheritedVariables(clazz) Get all inherited variables.
- .getLink(classname, path) Get the link to classname.
- .linkType(text = '', path) Create browsable links to a known entity.
- .linkTypes(text = '', path) Create browsable links for known entities.
- .readStandardJSON()
- .resolveDelegation(origin, ref, entity) Resolves delegations; that is, methods whose source content come from Conrefs, basically.
- .resolveDoc(data, entity, path) Resolve all tags on class and method json output.
- .resolveMixinMethods(name) Get a list of all methods from the given mixin name
- .resolveParamReferences() Resolve parameter references.
- .resolveSee(see, entity, path) Resolves curly-bracket reference links.
- .resolveTextReferences(text = '', entity, path) Search a text to find see links wrapped in curly braces.
- .verifyExternalObjReference(name)
Class Method Details
@getLinkMatch(text) Source
Constructor Details
.constructor(classes, mixins, options) Source
Construct a referencer.
Instance Method Details
.getConcernMethods(clazz) Source
Get all concerns
.getDirectSubClasses(clazz) Source
Get all direct subclasses.
.getExtendedMethods(clazz) Source
Get all extended mixins in the class hierarchy.
.getIncludedMethods(clazz) Source
Get all included mixins in the class hierarchy.
.getInheritedConstants(clazz) Source
Get all inherited constants.
.getInheritedMethods(clazz) Source
Get all inherited methods.
.getInheritedProperties(clazz) Source
Get all inherited properties.
.getInheritedVariables(clazz) Source
Get all inherited variables.
.getLink(classname, path) Source
Get the link to classname.
See {#linkTypes}.
.linkType(text = '', path) Source
Create browsable links to a known entity.
See {#getLink}.
.linkTypes(text = '', path) Source
Create browsable links for known entities.
See {#getLink}.
.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.
.resolveMixinMethods(name) Source
Get a list of all methods from the given mixin name
.resolveParamReferences() Source
Resolve parameter references. This goes through all
.resolveSee(see, entity, path) Source
Resolves curly-bracket reference links.
.resolveTextReferences(text = '', entity, path) Source
Search a text to find see links wrapped in curly braces.
Examples:
.verifyExternalObjReference(name) Source