method.tmpl 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <?js
  2. var data = obj;
  3. var self = this;
  4. ?>
  5. <?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
  6. <?js if (data.kind === 'class' && data.classdesc) { ?>
  7. <h2>Constructor</h2>
  8. <?js } ?>
  9. <?js if (data.kind !== 'namespace') { ?>
  10. <h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') +
  11. name + (data.signature || '') ?></h4>
  12. <?js } ?>
  13. <?js if (data.summary) { ?>
  14. <p class="summary"><?js= summary ?></p>
  15. <?js } ?>
  16. <?js } ?>
  17. <?js if (data.kind !== 'module' && data.description && !data.hideconstructor) { ?>
  18. <div class="description">
  19. <?js= data.description ?>
  20. </div>
  21. <?js } ?>
  22. <?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
  23. <h5>Extends:</h5>
  24. <?js= self.partial('augments.tmpl', data) ?>
  25. <?js } ?>
  26. <?js if (kind === 'event' && data.type && data.type.names) {?>
  27. <h5>Type:</h5>
  28. <ul>
  29. <li>
  30. <?js= self.partial('type.tmpl', data.type.names) ?>
  31. </li>
  32. </ul>
  33. <?js } ?>
  34. <?js if (data['this']) { ?>
  35. <h5>This:</h5>
  36. <ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
  37. <?js } ?>
  38. <?js if (data.params && params.length && !data.hideconstructor) { ?>
  39. <h5>Parameters:</h5>
  40. <?js= this.partial('params.tmpl', params) ?>
  41. <?js } ?>
  42. <?js= this.partial('details.tmpl', data) ?>
  43. <?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
  44. <h5>Requires:</h5>
  45. <ul><?js data.requires.forEach(function(r) { ?>
  46. <li><?js= self.linkto(r) ?></li>
  47. <?js }); ?></ul>
  48. <?js } ?>
  49. <?js if (data.fires && fires.length) { ?>
  50. <h5>Fires:</h5>
  51. <ul><?js fires.forEach(function(f) { ?>
  52. <li><?js= self.linkto(f) ?></li>
  53. <?js }); ?></ul>
  54. <?js } ?>
  55. <?js if (data.listens && listens.length) { ?>
  56. <h5>Listens to Events:</h5>
  57. <ul><?js listens.forEach(function(f) { ?>
  58. <li><?js= self.linkto(f) ?></li>
  59. <?js }); ?></ul>
  60. <?js } ?>
  61. <?js if (data.listeners && listeners.length) { ?>
  62. <h5>Listeners of This Event:</h5>
  63. <ul><?js listeners.forEach(function(f) { ?>
  64. <li><?js= self.linkto(f) ?></li>
  65. <?js }); ?></ul>
  66. <?js } ?>
  67. <?js if (data.modifies && modifies.length) {?>
  68. <h5>Modifies:</h5>
  69. <?js if (modifies.length > 1) { ?><ul><?js
  70. modifies.forEach(function(m) { ?>
  71. <li><?js= self.partial('modifies.tmpl', m) ?></li>
  72. <?js });
  73. ?></ul><?js } else {
  74. modifies.forEach(function(m) { ?>
  75. <?js= self.partial('modifies.tmpl', m) ?>
  76. <?js });
  77. } } ?>
  78. <?js if (data.exceptions && exceptions.length) { ?>
  79. <h5>Throws:</h5>
  80. <?js if (exceptions.length > 1) { ?><ul><?js
  81. exceptions.forEach(function(r) { ?>
  82. <li><?js= self.partial('exceptions.tmpl', r) ?></li>
  83. <?js });
  84. ?></ul><?js } else {
  85. exceptions.forEach(function(r) { ?>
  86. <?js= self.partial('exceptions.tmpl', r) ?>
  87. <?js });
  88. } } ?>
  89. <?js if (data.returns && returns.length) { ?>
  90. <h5>Returns:</h5>
  91. <?js if (returns.length > 1) { ?><ul><?js
  92. returns.forEach(function(r) { ?>
  93. <li><?js= self.partial('returns.tmpl', r) ?></li>
  94. <?js });
  95. ?></ul><?js } else {
  96. returns.forEach(function(r) { ?>
  97. <?js= self.partial('returns.tmpl', r) ?>
  98. <?js });
  99. } } ?>
  100. <?js if (data.yields && yields.length) { ?>
  101. <h5>Yields:</h5>
  102. <?js if (yields.length > 1) { ?><ul><?js
  103. yields.forEach(function(r) { ?>
  104. <li><?js= self.partial('returns.tmpl', r) ?></li>
  105. <?js });
  106. ?></ul><?js } else {
  107. yields.forEach(function(r) { ?>
  108. <?js= self.partial('returns.tmpl', r) ?>
  109. <?js });
  110. } } ?>
  111. <?js if (data.examples && examples.length) { ?>
  112. <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
  113. <?js= this.partial('examples.tmpl', examples) ?>
  114. <?js } ?>