DocParser Class
The doc parser accepts a map of files to file content.
Once parse()
is called, various properties will be populated
with the parsers data (aggregated in the 'data'
property).
Constructor
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _aggregateAttrs
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyHierarchy
- _destroyPlugins
- _filterAttrCfs
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getStateVal
- _initAttrs
- _initConfigPlugins
- _initHierarchy
- _initHierarchyData
- _initPlugins
- _isLazyAttr
- _normAttrVals
- _preInitEventCfg
- _protectAttrs
- _resolveFor
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- addAttr
- addAttrs
- attrAdded
- destroy
- extract
- fixType
- get
- getAttrs
- handlecomment
- hasPlugin
- init
- modifyAttr
- parse
- plug
- processblock
- removeAttr
- reset
- set
- setAttrs
- stringlog
- toString
- transform
- unindent
- unplug
Properties
Attributes
Methods
_addAttrs
-
cfgs
-
values
-
lazy
Implementation behind the public addAttrs method.
This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs.
-
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
-
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttr
-
name
Finishes initializing an attribute which has been lazily added.
Parameters:
-
name
ObjectThe name of the attribute
_aggregateAttrs
-
allAttrs
A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.
The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_defAttrChangeFn
-
e
Default function for attribute change events.
Parameters:
-
e
EventFacadeThe event object for attribute change events.
_defInitFn
-
e
Default init event handler
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyPlugins
()
private
Unplugs and destroys all plugins on the host
_filterAttrCfs
-
clazz
-
allCfgs
A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in .
Parameters:
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrName
StringThe name of the attribute
-
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
-
currVal
AnyThe current value of the attribute
-
newVal
AnyThe new value of the attribute
-
opts
ObjectAny additional event data to mix into the attribute change event's event facade.
_getAttr
-
name
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Returns an object with the configuration properties (and value) for the given attrubute. If attrName is not provided, returns the configuration properties for all attributes.
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.
Parameters:
Returns:
_getAttrs
-
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
Parameters:
-
attrs
Array | booleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function[]
protected
Returns the class hierarchy for this object, with Base being the last class in the array.
Returns:
_getStateVal
-
name
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
-
name
StringThe name of the attribute
Returns:
_initAttrs
-
attrs
-
values
-
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
-
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
-
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initConfigPlugins
-
config
A protected initialization method, used by the host class to initialize plugin configurations passed the constructor, through the config object.
Host objects should invoke this method at the appropriate time in their construction lifecycle.
Parameters:
-
config
ObjectThe configuration object passed to the constructor
_initHierarchy
-
userVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.
_initPlugins
-
config
Initializes static plugins registered on the host (using the Base.plug static method) and any plugins passed to the instance through the "plugins" configuration property.
Parameters:
-
config
ConfigThe configuration object with property name/value pairs.
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
name
StringThe name of the attribute
Returns:
_normAttrVals
-
valueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
Parameters:
-
valueHash
ObjectAn object with attribute name/value pairs
Returns:
_preInitEventCfg
-
config
Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.
Parameters:
-
config
ObjectThe user configuration object
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrs
ObjectA hash of attribute to configuration object pairs.
Returns:
_resolveFor
-
value
Takes a non-namespaced classname and resolves it to a namespace (to support @for
)
Parameters:
-
value
StringThe classname to resolve
Returns:
_set
-
name
-
val
-
opts
Allows setting of readOnly/writeOnce attributes. See set for argument details.
Parameters:
Returns:
_setAttr
-
name
-
value
-
opts
-
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
Parameters:
-
name
StringThe name of the attribute.
-
value
AnyThe value to set the attribute to.
-
opts
Object(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event.
-
force
BooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs.
Returns:
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
Returns:
_setStateVal
-
name
-
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
Parameters:
-
name
StringThe name of the attribute
-
value
AnyThe value of the attribute
addAttr
-
name
-
config
-
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
- setter <Function | String>
-
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
- getter <Function | String>
-
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
- validator <Function | String>
-
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
- broadcast <int>
- If and how attribute change events for this attribute should be broadcast. See CustomEvent's broadcast property for valid values. By default attribute change events are not broadcast.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
Parameters:
-
name
StringThe name of the attribute.
-
config
ObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute.
NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
-
lazy
Boolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs
-
values
-
lazy
Configures a group of attributes, and sets initial values.
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs.
-
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
-
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
destroy
()
Base
chainable
Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy.
Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.
Returns:
extract
-
filemap
-
dirmap
Accepts a map of filenames to file content. Returns a map of filenames to an array of API comment block text. This expects the comment to start with / ** on its own line, and end with * / on its own line. Override this function to provide an alternative comment parser.
Parameters:
Returns:
fixType
-
t
Takes a type string and converts it to a "First letter upper cased" type. e.g. (string -> String, object -> Object)
Parameters:
-
t
StringThe type string to convert
Returns:
get
-
name
Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.
Parameters:
-
name
StringThe name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g.
get("x.y.z")
)
Returns:
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
-
attrs
Array | booleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
handlecomment
-
comment
-
file
-
line
Transforms a JavaDoc style comment block (less the start and end of it) into a list of tag/text pairs. The leading space and '*' are removed, but the remaining whitespace is preserved so that the output should be friendly for both markdown and html parsers.
hasPlugin
-
ns
Determines if a plugin has plugged into this host.
Parameters:
-
ns
StringThe plugin's namespace
Returns:
init
-
config
Init lifecycle method, invoked during construction. Fires the init event prior to setting up attributes and invoking initializers for the class hierarchy.
Parameters:
-
config
ObjectObject with configuration property name/value pairs
Returns:
modifyAttr
-
name
-
config
Updates the configuration of an attribute which has already been added.
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.
parse
-
filemap
-
dirmap
Extracts and transforms the filemap provided to constructor
Parameters:
Returns:
plug
-
P
-
config
Adds a plugin to the host object. This will instantiate the plugin and attach it to the configured namespace on the host object.
Parameters:
-
P
Function | Object | ArrayAccepts the plugin class, or an object with a "fn" property specifying the plugin class and a "cfg" property specifying the configuration for the Plugin.
Additionally an Array can also be passed in, with the above function or object values, allowing the user to add multiple plugins in a single call.
-
config
Object(Optional) If the first argument is the plugin class, the second argument can be the configuration for the plugin.
Returns:
processblock
-
an
Processes all the tags in a single comment block
Parameters:
-
an
Arrayarray of the tag/text pairs
removeAttr
-
name
Removes an attribute from the host object
Parameters:
-
name
StringThe name of the attribute to be removed.
reset
-
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
Parameters:
-
name
StringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
set
-
name
-
value
-
opts
Sets the value of an attribute.
Parameters:
-
name
StringThe name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g.
set("x.y.z", 5)
). -
value
AnyThe value to set the attribute to.
-
opts
Object(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This can be used as a flexible way to identify the source of a call to set, allowing the developer to distinguish between set called internally by the host, vs. set called externally by the application developer.
Returns:
setAttrs
-
attrs
Sets multiple attribute values.
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs.
Returns:
stringlog
-
data
Parses the JSON data and formats it into a nice log string for filename and line number:
/file/name.js:123
Parameters:
-
data
ObjectThe data block from the parser
Returns:
toString
()
String
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
Returns:
transform
-
commentmap
Transforms a map of filenames to arrays of comment blocks into a JSON structure that represents the entire processed API doc info and relationships between elements for the entire project.
Parameters:
-
commentmap
ObjectThe hash of files and parsed comment blocks
Returns:
unindent
-
content
Normalizes the initial indentation of the given content so that the first line is unindented, and all other lines are unindented to the same degree as the first line. So if the first line has four spaces at the beginning, then all lines will be unindented four spaces. Ported from Selleck
Parameters:
-
content
StringText to unindent.
Returns:
Properties
DIGESTERS
Object
final
A map of the default tag processors, keyed by the tag name. Multiple tags can use the same digester by supplying the string name that points to the implementation rather than a function.
TAGLIST
Array
final
A list of known tags. This populates a member variable during initialization, and will be updated if additional digesters are added.
Attributes
currentclass
String
The class currently being parsed
Fires event currentclassChange
Fires when the value for the configuration attribute currentclass
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
currentfile
String
The file currently being parsed
Fires event currentfileChange
Fires when the value for the configuration attribute currentfile
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
currentmodule
String
The module currently being parsed
Fires event currentmoduleChange
Fires when the value for the configuration attribute currentmodule
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
currentsubmodule
String
The submodule currently being parsed
Fires event currentsubmoduleChange
Fires when the value for the configuration attribute currentsubmodule
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
destroyed
Boolean
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
Fires event destroyedChange
Fires when the value for the configuration attribute destroyed
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
digesters
Digesters process the tag/text pairs found in a comment block. They are looked up by tag name. The digester gets the tagname, the value, the target object to apply values to, and the full block that is being processed. Digesters can be declared as strings instead of a function -- in that case, the program will try to look up the key listed and use the function there instead (it is an alias). Digesters can return a host object in the case the tag defines a new key block type (modules/classes/methods/events/properties)
Fires event digestersChange
Fires when the value for the configuration attribute digesters
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
dirmap
A map of file names to directory name. Provided in case this needs to be used to reset the module name appropriately -- currently not used
Fires event dirmapChange
Fires when the value for the configuration attribute dirmap
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
emitters
Emitters will be schemas for the types of payloads the parser will emit. Not implemented.
Fires event emittersChange
Fires when the value for the configuration attribute emitters
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
filemap
The map of file names to file content.
Fires event filemapChange
Fires when the value for the configuration attribute filemap
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
initialized
Boolean
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
Fires event initializedChange
Fires when the value for the configuration attribute initialized
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
mainmodule
String
The main documentation block for the module itself.
Fires event mainmoduleChange
Fires when the value for the configuration attribute mainmodule
is
changed. You can listen for the event using the on
method if you
wish to be notified before the attribute's value has changed, or
using the after
method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
e
EventFacadeAn Event Facade object with the following attribute-specific properties added:
Events
destroy
Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
Event Payload:
-
e
EventFacadeEvent object
init
Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
Event Payload:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.