tags

  • property
documentjs.tags

{Object<String,tag>}

 

Object<String,tag>

The collection of tags used by documentjs.process.file to process comments and code. The default tags are listed on your left.

Use

A tag adds additional information to the comment being processed. For example, if you want the current comment to include the author, include an @author tag.

Creating your own tag

To create a tag, you need to add to documentjs.tags an object with an add and an optional addMore method like:

documentjs.tags.mytag = {
  add : function(line){ ... },
  addMore : function(line, last){ ... }
}