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

Added support for the @see tag.

Browse Source
This commit is contained in:
Michael Mathews 2011-01-16 11:49:06 +00:00
parent 176205c398
commit b309be6a01
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
modules/jsdoc/tag/dictionary/definitions.js
View File

@ -316,6 +316,16 @@
}
});
dictionary.defineTag('requires', {
mustHaveValue: true,
onTagged: function(doclet, tag) {
if (!doclet.requires) { doclet.requires = []; }
doclet.requires.push( firstWordOf(tag.value) );
return true;
}
});
dictionary.defineTag('returns', {
mustHaveValue: true,
canHaveType: true,
@ -442,4 +452,9 @@
}
}
function firstWordOf(string) {
var m = /^(\S+)/.exec(string);
if (m) { return m[1]; }
else { return ''; }
}
})();

1
test/runner.js
View File

@ -97,6 +97,7 @@ testFile('test/t/cases/exceptiontag.js');
testFile('test/t/cases/globaltag.js');
testFile('test/t/cases/ignoretag.js');
testFile('test/t/cases/paramtag.js');
testFile('test/t/cases/requirestag.js');
testFile('test/t/cases/returnstag.js');
testFile('test/t/cases/seetag.js');
testFile('test/t/cases/sincetag.js');