From 8afd06613f27a060dfbb0cb3170424ee33623a7c Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 16 Feb 2014 07:55:51 -0800 Subject: [PATCH] alphabetize the tag definitions --- lib/jsdoc/tag/dictionary/definitions.js | 72 ++++++++++++------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/lib/jsdoc/tag/dictionary/definitions.js b/lib/jsdoc/tag/dictionary/definitions.js index 0e74de84..04a210a3 100644 --- a/lib/jsdoc/tag/dictionary/definitions.js +++ b/lib/jsdoc/tag/dictionary/definitions.js @@ -165,15 +165,7 @@ exports.defineTags = function(dictionary) { } }); - dictionary.defineTag('author', { - mustHaveValue: true, - onTagged: function(doclet, tag) { - if (!doclet.author) { doclet.author = []; } - doclet.author.push(tag.value); - } - }); - - // I add on to that + // this symbol inherits from the specified symbol dictionary.defineTag('augments', { mustHaveValue: true, // Allow augments value to be specified as a normal type, e.g. {Type} @@ -188,7 +180,15 @@ exports.defineTags = function(dictionary) { }) .synonym('extends'); - // that adds on to me + dictionary.defineTag('author', { + mustHaveValue: true, + onTagged: function(doclet, tag) { + if (!doclet.author) { doclet.author = []; } + doclet.author.push(tag.value); + } + }); + + // this symbol has a member that should use the same docs as another symbol dictionary.defineTag('borrows', { mustHaveValue: true, onTagged: function(doclet, tag) { @@ -197,15 +197,6 @@ exports.defineTags = function(dictionary) { } }); - // that adds all of it's members to me - dictionary.defineTag('mixes', { - mustHaveValue: true, - onTagged: function(doclet, tag) { - var source = firstWordOf(tag.value); - doclet.mix(source); - } - }); - dictionary.defineTag('class', { onTagged: function(doclet, tag) { doclet.addTag('kind', 'class'); @@ -241,13 +232,6 @@ exports.defineTags = function(dictionary) { }) .synonym('const'); - dictionary.defineTag('copyright', { - mustHaveValue: true, - onTagged: function(doclet, tag) { - doclet.copyright = tag.value; - } - }); - dictionary.defineTag('constructs', { onTagged: function(doclet, tag) { var ownerClassName; @@ -262,6 +246,13 @@ exports.defineTags = function(dictionary) { } }); + dictionary.defineTag('copyright', { + mustHaveValue: true, + onTagged: function(doclet, tag) { + doclet.copyright = tag.value; + } + }); + dictionary.defineTag('default', { onTagged: function(doclet, tag) { var type; @@ -339,6 +330,16 @@ exports.defineTags = function(dictionary) { }) .synonym('throws'); + dictionary.defineTag('exports', { + mustHaveValue: true, + onTagged: function(doclet, tag) { + var modName = firstWordOf(tag.value); + + doclet.addTag('alias', modName); + doclet.addTag('kind', 'module'); + } + }); + dictionary.defineTag('external', { canHaveType: true, isNamespace: true, @@ -352,16 +353,6 @@ exports.defineTags = function(dictionary) { }) .synonym('host'); - dictionary.defineTag('exports', { - mustHaveValue: true, - onTagged: function(doclet, tag) { - var modName = firstWordOf(tag.value); - - doclet.addTag('alias', modName); - doclet.addTag('kind', 'module'); - } - }); - dictionary.defineTag('file', { onTagged: function(doclet, tag) { setNameToFile(doclet, tag); @@ -478,6 +469,15 @@ exports.defineTags = function(dictionary) { }) .synonym('memberof!'); + // this symbol mixes in all of the specified object's members + dictionary.defineTag('mixes', { + mustHaveValue: true, + onTagged: function(doclet, tag) { + var source = firstWordOf(tag.value); + doclet.mix(source); + } + }); + dictionary.defineTag('mixin', { onTagged: function(doclet, tag) { setDocletKindToTitle(doclet, tag);