alphabetize the tag definitions

This commit is contained in:
Jeff Williams 2014-02-16 07:55:51 -08:00
parent 3ae23b8b21
commit 8afd06613f

View File

@ -165,15 +165,7 @@ exports.defineTags = function(dictionary) {
} }
}); });
dictionary.defineTag('author', { // this symbol inherits from the specified symbol
mustHaveValue: true,
onTagged: function(doclet, tag) {
if (!doclet.author) { doclet.author = []; }
doclet.author.push(tag.value);
}
});
// I add on to that
dictionary.defineTag('augments', { dictionary.defineTag('augments', {
mustHaveValue: true, mustHaveValue: true,
// Allow augments value to be specified as a normal type, e.g. {Type} // Allow augments value to be specified as a normal type, e.g. {Type}
@ -188,7 +180,15 @@ exports.defineTags = function(dictionary) {
}) })
.synonym('extends'); .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', { dictionary.defineTag('borrows', {
mustHaveValue: true, mustHaveValue: true,
onTagged: function(doclet, tag) { 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', { dictionary.defineTag('class', {
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
doclet.addTag('kind', 'class'); doclet.addTag('kind', 'class');
@ -241,13 +232,6 @@ exports.defineTags = function(dictionary) {
}) })
.synonym('const'); .synonym('const');
dictionary.defineTag('copyright', {
mustHaveValue: true,
onTagged: function(doclet, tag) {
doclet.copyright = tag.value;
}
});
dictionary.defineTag('constructs', { dictionary.defineTag('constructs', {
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
var ownerClassName; 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', { dictionary.defineTag('default', {
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
var type; var type;
@ -339,6 +330,16 @@ exports.defineTags = function(dictionary) {
}) })
.synonym('throws'); .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', { dictionary.defineTag('external', {
canHaveType: true, canHaveType: true,
isNamespace: true, isNamespace: true,
@ -352,16 +353,6 @@ exports.defineTags = function(dictionary) {
}) })
.synonym('host'); .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', { dictionary.defineTag('file', {
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
setNameToFile(doclet, tag); setNameToFile(doclet, tag);
@ -478,6 +469,15 @@ exports.defineTags = function(dictionary) {
}) })
.synonym('memberof!'); .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', { dictionary.defineTag('mixin', {
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
setDocletKindToTitle(doclet, tag); setDocletKindToTitle(doclet, tag);