-
Notifications
You must be signed in to change notification settings - Fork 151
Exemplary APIs
Lloyd Brookes edited this page Aug 7, 2016
·
9 revisions
Feel free to add your own!
- Polymer/polymer-analyzer
- mhelvens/graph.js
- jesucarr/tokenbucket
- alexmingoia/koa-router
- IjzerenHein/famous-map
Project | Notes |
---|---|
handbrake-js |
A module exposing two methods and an inner class. Demonstrates documenting events, linked types and use of `@external` combined with `@see`.The API docs are inserted into this README template by this command: |
command-line-args | Demonstrates documentation of ES2015 classes plus the @module , @typicalname , @throws and @alias tags. |
array-tools | Very simple module exporting a collection of static methods. Demonstrates use of @category to group identifiers in the member-list. |
jesucarr/tokenbucket | Demonstrates --param-list-format list and the documentation of Promises using the @fulfil and @reject tags. |
ansi-escape-sequences | Demonstrates usage of @enum {type} (rendered in table format). |
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting