node-query/node_modules/jsdoc/templates/default/tmpl/details.tmpl

144 lines
4.6 KiB
Cheetah
Raw Normal View History

2014-10-20 16:56:45 -04:00
<?js
var data = obj;
var self = this;
var defaultObjectClass = '';
2014-10-22 10:11:40 -04:00
// Check if the default value is an object or array; if so, apply code highlighting
if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
2014-10-20 16:56:45 -04:00
data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
defaultObjectClass = ' class="object-value"';
}
?>
2015-01-28 15:33:44 -05:00
<?js
var properties = data.properties;
if (properties && properties.length && properties.forEach) {
?>
2014-10-22 10:11:40 -04:00
2015-01-28 15:33:44 -05:00
<h5 class="subsection-title">Properties:</h5>
2014-10-22 10:11:40 -04:00
2015-01-28 15:33:44 -05:00
<?js= this.partial('properties.tmpl', data) ?>
2014-10-22 10:11:40 -04:00
2015-01-28 15:33:44 -05:00
<?js } ?>
<dl class="details">
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.version) {?>
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li><?js= version ?></li></ul></dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.since) {?>
<dt class="tag-since">Since:</dt>
2015-01-28 15:33:44 -05:00
<dd class="tag-since"><ul class="dummy"><li><?js= since ?></li></ul></dd>
2014-10-20 16:56:45 -04:00
<?js } ?>
2015-01-28 15:33:44 -05:00
<?js if (data.inherited && data.inherits && !data.overrides) { ?>
2014-10-20 16:56:45 -04:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
2015-01-28 15:33:44 -05:00
</li></ul></dd>
<?js } ?>
<?js if (data.overrides) { ?>
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
</li></ul></dd>
<?js } ?>
<?js if (data.implementations && data.implementations.length) { ?>
<dt class="implementations">Implementations:</dt>
<dd class="implementations"><ul>
<?js data.implementations.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?>
</ul></dd>
<?js } ?>
<?js if (data.implements && data.implements.length) { ?>
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<?js data.implements.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?>
</ul></dd>
<?js } ?>
<?js if (data.mixes && data.mixes.length) { ?>
<dt class="mixes">Mixes In:</dt>
<dd class="mixes"><ul>
<?js data.mixes.forEach(function(a) { ?>
<li><?js= self.linkto(a, a) ?></li>
<?js }); ?>
</ul></dd>
2014-10-20 16:56:45 -04:00
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.deprecated) { ?>
<dt class="important tag-deprecated">Deprecated:</dt><?js
if (data.deprecated === true) { ?><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd><?js }
2015-01-28 15:33:44 -05:00
else { ?><dd><ul class="dummy"><li><?js= data.deprecated ?></li></ul></dd><?js }
2014-10-20 16:56:45 -04:00
?>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.author && author.length) {?>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul><?js author.forEach(function(a) { ?>
<li><?js= self.resolveAuthorLinks(a) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.copyright) {?>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li><?js= copyright ?></li></ul></dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.license) {?>
<dt class="tag-license">License:</dt>
<dd class="tag-license"><ul class="dummy"><li><?js= license ?></li></ul></dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.defaultvalue) {?>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
</ul></dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
<?js if (data.meta && self.outputSourceFiles) {?>
2014-10-20 16:56:45 -04:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-10-22 10:11:40 -04:00
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
2014-10-20 16:56:45 -04:00
</li></ul></dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.tutorials && tutorials.length) {?>
<dt class="tag-tutorial">Tutorials:</dt>
<dd class="tag-tutorial">
<ul><?js tutorials.forEach(function(t) { ?>
<li><?js= self.tutoriallink(t) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.see && see.length) {?>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul><?js see.forEach(function(s) { ?>
<li><?js= self.linkto(s) ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
2014-10-22 10:11:40 -04:00
2014-10-20 16:56:45 -04:00
<?js if (data.todo && todo.length) {?>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul><?js todo.forEach(function(t) { ?>
<li><?js= t ?></li>
<?js }); ?></ul>
</dd>
<?js } ?>
</dl>