itcast 6e512b8ce6 aaaa 10 月之前
..
LICENSE 6e512b8ce6 aaaa 10 月之前
README.md 6e512b8ce6 aaaa 10 月之前
plugin.js 6e512b8ce6 aaaa 10 月之前
publish.js 6e512b8ce6 aaaa 10 月之前

README.md

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