details.tmpl 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. <?js
  2. var data = obj;
  3. var self = this;
  4. var defaultObjectClass = '';
  5. // Check if the default value is an object or array; if so, apply code highlighting
  6. if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
  7. try {
  8. var indentedValues = JSON.stringify(JSON.parse(data.defaultvalue), null, ' ');
  9. data.defaultvalue = indentedValues;
  10. } catch (e) {}
  11. data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
  12. defaultObjectClass = ' class="object-value"';
  13. }
  14. ?>
  15. <dl class="details">
  16. <?js if (data.description) {?>
  17. <dt class="tag-description">Description:</dt>
  18. <dd class="tag-description"><ul class="dummy"><li><?js= data.description ?></li></ul></dd>
  19. <?js } ?>
  20. <?js if (data.meta && self.outputSourceFiles) {?>
  21. <dt class="tag-source">Source:</dt>
  22. <dd class="tag-source"><ul class="dummy"><li>
  23. <?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
  24. </li></ul></dd>
  25. <?js } ?>
  26. <?js if (data.version) {?>
  27. <dt class="tag-version">Version:</dt>
  28. <dd class="tag-version"><ul class="dummy"><li><?js= version ?></li></ul></dd>
  29. <?js } ?>
  30. <?js if (data.since) {?>
  31. <dt class="tag-since">Since:</dt>
  32. <dd class="tag-since"><ul class="dummy"><li><?js= since ?></li></ul></dd>
  33. <?js } ?>
  34. <?js if (data.inherited && data.inherits && !data.overrides) { ?>
  35. <dt class="inherited-from">Inherited From:</dt>
  36. <dd class="inherited-from"><ul class="dummy"><li>
  37. <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
  38. </li></ul></dd>
  39. <?js } ?>
  40. <?js if (data.overrides) { ?>
  41. <dt class="tag-overrides">Overrides:</dt>
  42. <dd class="tag-overrides"><ul class="dummy"><li>
  43. <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
  44. </li></ul></dd>
  45. <?js } ?>
  46. <?js if (data.implementations && data.implementations.length) { ?>
  47. <dt class="implementations">Implementations:</dt>
  48. <dd class="implementations"><ul>
  49. <?js data.implementations.forEach(function(impl) { ?>
  50. <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
  51. <?js }); ?>
  52. </ul></dd>
  53. <?js } ?>
  54. <?js if (data.implements && data.implements.length) { ?>
  55. <dt class="implements">Implements:</dt>
  56. <dd class="implements"><ul>
  57. <?js data.implements.forEach(function(impl) { ?>
  58. <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
  59. <?js }); ?>
  60. </ul></dd>
  61. <?js } ?>
  62. <?js if (data.mixes && data.mixes.length) { ?>
  63. <dt class="mixes">Mixes In:</dt>
  64. <dd class="mixes"><ul>
  65. <?js data.mixes.forEach(function(a) { ?>
  66. <li><?js= self.linkto(a, a) ?></li>
  67. <?js }); ?>
  68. </ul></dd>
  69. <?js } ?>
  70. <?js if (data.deprecated) { ?>
  71. <dt class="important tag-deprecated">Deprecated:</dt><?js
  72. if (data.deprecated === true) { ?><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><?js }
  73. else { ?><dd><ul class="dummy"><li><?js= data.deprecated ?></li></ul></dd><?js }
  74. ?>
  75. <?js } ?>
  76. <?js if (data.author && author.length) {?>
  77. <dt class="tag-author">Author:</dt>
  78. <dd class="tag-author">
  79. <ul><?js author.forEach(function(a) { ?>
  80. <li><?js= self.resolveAuthorLinks(a) ?></li>
  81. <?js }); ?></ul>
  82. </dd>
  83. <?js } ?>
  84. <?js if (data.copyright) {?>
  85. <dt class="tag-copyright">Copyright:</dt>
  86. <dd class="tag-copyright"><ul class="dummy"><li><?js= copyright ?></li></ul></dd>
  87. <?js } ?>
  88. <?js if (data.license) {?>
  89. <dt class="tag-license">License:</dt>
  90. <dd class="tag-license"><ul class="dummy"><li><?js= license ?></li></ul></dd>
  91. <?js } ?>
  92. <?js if (data.defaultvalue) {?>
  93. <dt class="tag-default">Default Value:</dt>
  94. <dd class="tag-default"><ul class="dummy">
  95. <li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
  96. </ul></dd>
  97. <?js } ?>
  98. <?js if (data.tutorials && tutorials.length) {?>
  99. <dt class="tag-tutorial">Tutorials:</dt>
  100. <dd class="tag-tutorial">
  101. <ul><?js tutorials.forEach(function(t) { ?>
  102. <li><?js= self.tutoriallink(t) ?></li>
  103. <?js }); ?></ul>
  104. </dd>
  105. <?js } ?>
  106. <?js if (data.see && see.length) {?>
  107. <dt class="tag-see">See:</dt>
  108. <dd class="tag-see">
  109. <ul><?js see.forEach(function(s) { ?>
  110. <li><?js= self.linkto(s) ?></li>
  111. <?js }); ?></ul>
  112. </dd>
  113. <?js } ?>
  114. <?js if (data.todo && todo.length) {?>
  115. <dt class="tag-todo">To Do:</dt>
  116. <dd class="tag-todo">
  117. <ul><?js todo.forEach(function(t) { ?>
  118. <li><?js= t ?></li>
  119. <?js }); ?></ul>
  120. </dd>
  121. <?js } ?>
  122. </dl>
  123. <?js
  124. var properties = data.properties;
  125. if (properties && properties.length && properties.forEach) {
  126. ?>
  127. <h5 class="subsection-title">Properties:</h5>
  128. <?js= this.partial('properties.tmpl', data) ?>
  129. <?js } ?>