1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
| JSDOC.PluginManager.registerPlugin(
| "JSDOC.tagSynonyms",
| {
| onDocCommentSrc: function(comment) {
| comment.src = comment.src.replace(/@methodOf\b/i, "@function\n@memberOf");
| comment.src = comment.src.replace(/@fieldOf\b/i, "@field\n@memberOf");
| },
|
| onDocCommentTags: function(comment) {
| for (var i = 0, l = comment.tags.length; i < l; i++) {
| var title = comment.tags[i].title.toLowerCase();
| var syn;
| if ((syn = JSDOC.tagSynonyms.synonyms["="+title])) {
| comment.tags[i].title = syn;
| }
| }
| }
| }
| );
|
| new Namespace(
| "JSDOC.tagSynonyms",
| function() {
| JSDOC.tagSynonyms.synonyms = {
| "=member": "memberOf",
| "=memberof": "memberOf",
| "=description": "desc",
| "=exception": "throws",
| "=argument": "param",
| "=returns": "return",
| "=classdescription": "class",
| "=fileoverview": "overview",
| "=extends": "augments",
| "=base": "augments",
| "=projectdescription": "overview",
| "=classdescription": "class",
| "=link": "see",
| "=borrows": "inherits",
| "=scope": "lends",
| "=construct": "constructor"
| }
| }
| );
|
|
