/tags/jsdoc_toolkit-2.2.1/jsdoc-toolkit/app/plugins/tagSynonyms.js

http://jsdoc-toolkit.googlecode.com/ · JavaScript · 43 lines · 41 code · 2 blank · 0 comment · 2 complexity · cd8a1c7903eb5a0b0ce5f2e3f63fbef0 MD5 · raw file

  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. onDocCommentTags: function(comment) {
  9. for (var i = 0, l = comment.tags.length; i < l; i++) {
  10. var title = comment.tags[i].title.toLowerCase();
  11. var syn;
  12. if ((syn = JSDOC.tagSynonyms.synonyms["="+title])) {
  13. comment.tags[i].title = syn;
  14. }
  15. }
  16. }
  17. }
  18. );
  19. new Namespace(
  20. "JSDOC.tagSynonyms",
  21. function() {
  22. JSDOC.tagSynonyms.synonyms = {
  23. "=member": "memberOf",
  24. "=memberof": "memberOf",
  25. "=description": "desc",
  26. "=exception": "throws",
  27. "=argument": "param",
  28. "=returns": "return",
  29. "=classdescription": "class",
  30. "=fileoverview": "overview",
  31. "=extends": "augments",
  32. "=base": "augments",
  33. "=projectdescription": "overview",
  34. "=classdescription": "class",
  35. "=link": "see",
  36. "=borrows": "inherits",
  37. "=scope": "lends",
  38. "=construct": "constructor"
  39. }
  40. }
  41. );