Module: jsdoc/tag/dictionary/definitions

Define tags that are known in JSDoc.
Author:
License:
  • Apache License 2.0 - See file 'LICENSE.md' in this project.
Source:

Methods

(static) defineTags(dictionary, tagDefinitionsopt)

Populate the given dictionary with the appropriate JSDoc tag definitions. If the `tagDefinitions` parameter is omitted, JSDoc uses its configuration settings to decide which tags to add to the dictionary. If the `tagDefinitions` parameter is included, JSDoc adds only the tag definitions from the `tagDefinitions` object. The configuration settings are ignored.
Parameters:
Name Type Attributes Description
dictionary module:jsdoc/tag/dictionary
tagDefinitions Object <optional>
 A dictionary whose values define the rules for a JSDoc tag.
Source: