js-comments-template
Advanced tools
Readme
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
.isRegistered
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 | homepageoption, enable and disable. See the readme… more | homepagePull 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.
FAQs
Default template used by js-comments and helper-apidocs for generating API docs.
We found that js-comments-template demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).