trueif this tag should process this line of code.
documentjs.process.code passes the line of code after a comment block to each tag's
codeMatchfunction. The first tag whose
codeMatchreturns true will have its
codemethod called with the same line.
Returns properties that should be set on the comment's docObject.
code(codeLine)returns a DocObject, set this object as the new scope.
addis called when a comment line starts with
@followed by the tag name. This function can:
- add directly to the docObject
- push something onto the stack
- pop some data off the stack
- change the default property lines are written to
- add to docMap
- change the scope
['scope', scopeDocObject]or the scope and the docObject being added to
The stack is used to handle tags that might be nested, for example
@codeend. It provides something to collect data until the closing tag, and have the compiled data "popped" to the parent.
addMoreis called if
addreturns an object.
endis called on a tag when the comment switches to another tag.