Interface JSDocParseOptions

interface JSDocParseOptions {
    end?: string | RegExp;
    line?: string | RegExp;
    start?: string | RegExp;
}

Index

Properties

end? line? start?

Properties

`Optional` `Readonly`end

end?: string | RegExp

The end symbol of your comment format. Defaults to */.

`Optional` `Readonly`line

line?: string | RegExp

The symbol that start a line of your comment format. Defaults to *.

`Optional` `Readonly`start

start?: string | RegExp

The start symbol of your comment format. Defaults to /**.