• typedef



An options object passed to several of the process methods.



  1. tags {tags}

    The tag collection to be used to process the comment.

  2. comment {String}

    The comment to be converted

  3. scope {docObject}

    A docObject that can be a parent to the current docObject.

  4. docMap {docMap}

    The map of all docObjects.

  5. docObject {docObject}Optional

    If provided, this will be used as the docObject. This is useful for adding properties to an existing object.

  6. code {String}Optional

    The code immediately preceeding the comment.