Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.
/ hambruger Public archive

Converts JSDOC3 into Markdown to be thrown up on your Github README/Wiki or Flatdoc.

License

Notifications You must be signed in to change notification settings

aef-/hambruger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

brugerking

hambruger

Converts JSDOC3 into Markdown to be thrown up on your Github README/Wiki or Flatdoc.

Usage

$ npm install -g hambruger 
$ cat src/hambruger.js | hambruger >> API.md

Include only explicitly @public methods.

$ cat src/hambruger.js | hambruger --only-public >> API.md

Exclude explicitly @private methods.

$ cat src/hambruger.js | hambruger --exclude-private >> API.md

Supported Tags

/**
 * Description of object. Requires object to directly follow comment block.
 * @constructor
 * @param {object} options Description of options
 * @param {string} options.prop Description of property
 * @private
 * @public
 */
function Example( options ) {
}

Examples

Will provide more extensive ones as more projects use this and the behaviour is fleshed out. For now, here you go: examples.

About

Converts JSDOC3 into Markdown to be thrown up on your Github README/Wiki or Flatdoc.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published