1
0
mirror of https://github.com/musix-org/musix-oss synced 2024-09-20 20:21:55 +00:00
musix-oss/node_modules/protobufjs/cli/lib/tsd-jsdoc/README.md
2020-03-03 22:30:50 +02:00

923 B

protobuf.js fork of tsd-jsdoc

This is a modified version of tsd-jsdoc v1.0.1 for use with protobuf.js, parked here so we can process issues and pull requests. The ultimate goal is to switch back to the a recent version of tsd-jsdoc once it meets our needs.

Options

  • module: string
    Wraps everything in a module of the specified name.

  • private: boolean
    Includes private members when set to true.

  • comments: boolean
    Skips comments when explicitly set to false.

  • destination: string|boolean
    Saves to the specified destination file or to console when set to false.

Setting options on the command line

Providing -q, --query <queryString> on the command line will set respectively override existing options. Example: -q module=protobufjs