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