Docstring Class

Defined in: packages/megadoc-plugin-js/lib/Parser/Docstring.js

An object representing a JSDoc comment (parsed using dox).

Constructor Documentation

Docstring(comment: String)

Parameters (1)

comment
String

The JSDoc-compatible comment string to build from.

Instance Method Documentation

    toJSON() -> Object

    Return Values

    doc
    Object
    doc.name
    String

    If this is a module, it will be the name of the module found in a

    doc.namespace
    String

    The namespace name found in a @namespace tag, if any.

    doc.description
    String

    The free-text found in the docstring.

    doc.tags
    Array.<Tag>

    All the JSDoc tags found in the docstring.

Contents