Created
April 25, 2016 15:54
-
-
Save jacopotarantino/4949a38e227fcebbbb1e8cc9ee7d7251 to your computer and use it in GitHub Desktop.
Example of adding a tag to jsdoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 'use strict' | |
| /** | |
| * JSDoc dictionary that enables `@sideffects` as a tag. | |
| */ | |
| exports.defineTags = function (dictionary) { | |
| dictionary.defineTag('sideeffects', { | |
| onTagged: function (doclet, tag) { | |
| doclet.has_sideffects = tag.value || true | |
| }, | |
| synonyms: ['sideffects'] | |
| }) | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment