method.tmpl 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. <?js
  2. var data = obj;
  3. var self = this;
  4. ?>
  5. <dt>
  6. <?js
  7. var h4Title = data.attribs + name + (kind !== 'event' ? data.signature : '') ;
  8. h4Title = '<h4 class="name" id="' + id + '">' + h4Title + '</h4>';
  9. ?>
  10. <?js if (data.meta && self.outputSourceFiles) {?>
  11. <?js= self.linkto(meta.shortpath, h4Title, 'name-link', 'line' + meta.lineno) ?>
  12. <?js } else { ?>
  13. <?js= h4Title ?>
  14. <?js } ?>
  15. <?js if (data.summary) { ?>
  16. <p class="summary"><?js= summary ?></p>
  17. <?js } ?>
  18. </dt>
  19. <dd>
  20. <?js if (data.description) { ?>
  21. <div class="description">
  22. <?js= data.description ?>
  23. </div>
  24. <?js } ?>
  25. <?js if (kind === 'event' && data.type && data.type.names) {?>
  26. <h5>Type:</h5>
  27. <ul>
  28. <li>
  29. <?js= self.partial('type.tmpl', data.type.names) ?>
  30. </li>
  31. </ul>
  32. <?js } ?>
  33. <?js if (data['this']) { ?>
  34. <h5>This:</h5>
  35. <ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
  36. <?js } ?>
  37. <?js if (data.params && params.length) { ?>
  38. <h5>Parameters:</h5>
  39. <?js= this.partial('params.tmpl', params) ?>
  40. <?js } ?>
  41. <?js= this.partial('details.tmpl', data) ?>
  42. <?js if (data.requires && data.requires.length) { ?>
  43. <h5>Requires:</h5>
  44. <ul><?js data.requires.forEach(function(r) { ?>
  45. <li><?js= self.linkto(r) ?></li>
  46. <?js }); ?></ul>
  47. <?js } ?>
  48. <?js if (data.fires && fires.length) { ?>
  49. <h5>Fires:</h5>
  50. <ul><?js fires.forEach(function(f) { ?>
  51. <li><?js= self.linkto(f) ?></li>
  52. <?js }); ?></ul>
  53. <?js } ?>
  54. <?js if (data.listens && listens.length) { ?>
  55. <h5>Listens to Events:</h5>
  56. <ul><?js listens.forEach(function(f) { ?>
  57. <li><?js= self.linkto(f) ?></li>
  58. <?js }); ?></ul>
  59. <?js } ?>
  60. <?js if (data.listeners && listeners.length) { ?>
  61. <h5>Listeners of This Event:</h5>
  62. <ul><?js listeners.forEach(function(f) { ?>
  63. <li><?js= self.linkto(f) ?></li>
  64. <?js }); ?></ul>
  65. <?js } ?>
  66. <?js if (data.exceptions && exceptions.length) { ?>
  67. <h5>Throws:</h5>
  68. <?js if (exceptions.length > 1) { ?><ul><?js
  69. exceptions.forEach(function(r) { ?>
  70. <li><?js= self.partial('exceptions.tmpl', r) ?></li>
  71. <?js });
  72. ?></ul><?js } else {
  73. exceptions.forEach(function(r) { ?>
  74. <?js= self.partial('exceptions.tmpl', r) ?>
  75. <?js });
  76. } } ?>
  77. <?js if (data.returns && returns.length) { ?>
  78. <h5>Returns:</h5>
  79. <?js if (returns.length > 1) { ?><ul><?js
  80. returns.forEach(function(r) { ?>
  81. <li><?js= self.partial('returns.tmpl', r) ?></li>
  82. <?js });
  83. ?></ul><?js } else {
  84. returns.forEach(function(r) { ?>
  85. <?js= self.partial('returns.tmpl', r) ?>
  86. <?js });
  87. } } ?>
  88. <?js if (data.examples && examples.length) { ?>
  89. <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
  90. <?js= this.partial('examples.tmpl', examples) ?>
  91. <?js } ?>
  92. </dd>