archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

correct docs

Browse Source
This commit is contained in:
Jeff Williams 2014-12-07 13:03:43 -08:00
parent c0b7b784a2
commit e02ed2f7fe
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/jsdoc/tag/dictionary/definitions.js
View File

@ -830,11 +830,11 @@ function addTagDefinitions(dictionary, tagDefs) {
/**
* Populate the given dictionary with the appropriate JSDoc tag definitions.
*
* If the `tagDefs` parameter is omitted, JSDoc uses its configuration settings to decide which
* tags to add to the dictionary.
* If the `tagDefinitions` parameter is omitted, JSDoc uses its configuration settings to decide
* which tags to add to the dictionary.
*
* If the `tagDefs` parameter is included, JSDoc adds only the tag definitions from the `tagDefs`
* object. The configuration settings are ignored.
* If the `tagDefinitions` parameter is included, JSDoc adds only the tag definitions from the
* `tagDefinitions` object. The configuration settings are ignored.
*
* @param {module:jsdoc/tag/dictionary} dictionary
* @param {Object} [tagDefinitions] - A dictionary whose values define the rules for a JSDoc tag.