Default template used by js-comments for generating API docs.
MIT License
Default template used by js-comments and helper-apidocs for generating API docs.
Install with npm:
$ npm install --save js-comments-template
The comment template creates a comment section in a markdown document, with any or all of the following sub-sections (sub-sections only render if defined in the comment):
heading
: section title/heading, linked to the actual code on GitHub associated with the comment. Heading can be set explicity with a @name
tag.params
: A list of parameters and descriptions, defined with the @param
tag.examples
: gfm formatted code blocks, defined in a block comment using gfm syntax.returns
: a return statement, defined with the @return
tagevents
: any events emitted, defined with the @emits
tagRendered markdown
Returns true if a plugin has already been registered on an instance. This is optionally used by plugin implementors to prevent plugins from being called on an instanced more than once.
Events
emits
: plugin
with registered
and the name of the plugin as arguments.Params
name
{String}: The plugin name.returns
{Boolean}: Returns true when a plugin is already registered.Example
var base = new Base();
base.use(function(app) {
if (app.isRegistered('myPlugin')) {
return;
}
// do stuff
});
Thousands of projects use this template. Here are a few examples:
config
method for mapping declarative configuration values to other 'base… more | homepage
option
, enable
and disable
. See the readme… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Commits | Contributor |
---|---|
30 | jonschlinkert |
1 | tunnckoCore |
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.2.0, on December 13, 2016.