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