Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/jsdoc2md/jsdoc-to-markdown below:

jsdoc2md/jsdoc-to-markdown: Generate markdown documentation from jsdoc-annotated javascript

Upgraders, please read the release notes

Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

1. Document your code using valid jsdoc comments.

/**
 * A quite wonderful function.
 * @param {object} - Privacy gown
 * @param {object} - Security
 * @returns {survival}
 */
function protection (cloak, dagger) {}

2. Run a command.

3. Get markdown output.

## protection(cloak, dagger) ⇒ <code>survival</code>
A quite wonderful function.

**Kind**: global function

| Param  | Type                | Description  |
| ------ | ------------------- | ------------ |
| cloak  | <code>object</code> | Privacy gown |
| dagger | <code>object</code> | Security     |

$ npm install --save-dev jsdoc-to-markdown

• API documentation
• The wiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.

© 2014-25 Lloyd Brookes <opensource@75lb.com>.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4