bit-docs-process-tags/process-tags module
processTags(options, callback)
Use this module to process a TagBlock and use any matching Tag in the TagCollection to further process the line and return a new DocObject.
Parameters
- options
{ProcessTagsOptions}
:The block to process and the TagCollection.
Notable options:
tags
: TagCollection to draw from.comment
: TagBlock being processed.
- callback
{ProcessorCallback(newDoc, newScope)}
:Callback to call when done processing.
The new DocObject might be null if no Tags in the TagCollection matched a line in the TagBlock.
Use
This module manages a ProcessTagsStack using ProcessTagsCommand commands.
Plugins add to the TagCollection using the
tags
hook so the Tag processing rules are applied when
processing blocks.