• function

documentjs.process.comment(options, callback)

Processes a comment and produces a docObject.


  1. options {processOptions}

    An options object that contains the code and comment to process.

  2. callback {function(newDoc, newScope)}

    A function that is called back with a docObject created from the code and the scope docObject. If no docObject is created, newDoc will be null.

Processing rules

The processing rules can be found in the Tag interface.