4def0c6a84
This renames the doc task to apidoc. The apidoc delegates to jsdoc3 currently. We will have additional documentation that is not built by jsdoc3. It makes sense to reserve the more general 'doc' name for building all documentation (not just apidoc).
77 lines
2.1 KiB
Cheetah
77 lines
2.1 KiB
Cheetah
<?js
|
|
var data = obj;
|
|
var self = this;
|
|
?>
|
|
<dt>
|
|
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind == 'class'? 'new ':'') + name + data.signature ?></h4>
|
|
|
|
<?js if (data.summary) { ?>
|
|
<p class="summary"><?js= summary ?></p>
|
|
<?js } ?>
|
|
</dt>
|
|
<dd>
|
|
|
|
<?js if (data.description) { ?>
|
|
<div class="description">
|
|
<?js= data.description ?>
|
|
</div>
|
|
<?js } ?>
|
|
|
|
<?js if (kind === 'event' && data.type && data.type.names) {?>
|
|
<h5>Type:</h5>
|
|
<ul>
|
|
<li>
|
|
<?js= self.partial('type.tmpl', data.type.names) ?>
|
|
</li>
|
|
</ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data['this']) { ?>
|
|
<h5>This:</h5>
|
|
<ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data.params && params.length) { ?>
|
|
<h5>Parameters:</h5>
|
|
<?js= this.partial('params.tmpl', params) ?>
|
|
<?js } ?>
|
|
|
|
<?js= this.partial('details.tmpl', data) ?>
|
|
|
|
<?js if (data.fires && fires.length) { ?>
|
|
<h5>Fires:</h5>
|
|
<ul><?js fires.forEach(function(f) { ?>
|
|
<?js= self.partial('fires.tmpl', self.linkto(f) ) ?>
|
|
<?js }); ?></ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data.exceptions && exceptions.length) { ?>
|
|
<h5>Throws:</h5>
|
|
<?js if (exceptions.length > 1) { ?><ul><?js
|
|
exceptions.forEach(function(r) { ?>
|
|
<li><?js= self.partial('exceptions.tmpl', r) ?></li>
|
|
<?js });
|
|
?></ul><?js } else {
|
|
exceptions.forEach(function(r) { ?>
|
|
<?js= self.partial('exceptions.tmpl', r) ?>
|
|
<?js });
|
|
} } ?>
|
|
|
|
<?js if (data.returns && returns.length) { ?>
|
|
<h5>Returns:</h5>
|
|
<?js if (returns.length > 1) { ?><ul><?js
|
|
returns.forEach(function(r) { ?>
|
|
<li><?js= self.partial('returns.tmpl', r) ?></li>
|
|
<?js });
|
|
?></ul><?js } else {
|
|
returns.forEach(function(r) { ?>
|
|
<?js= self.partial('returns.tmpl', r) ?>
|
|
<?js });
|
|
} } ?>
|
|
|
|
<?js if (data.examples && examples.length) { ?>
|
|
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
|
|
<?js= this.partial('examples.tmpl', examples) ?>
|
|
<?js } ?>
|
|
</dd>
|