jsdoc/templates/default/tmpl/method.tmpl

73 lines
1.9 KiB
Cheetah

<dt>
<h4 class="name" id="<?js= id ?>"><?js= this.attribs + (kind == 'class'? 'new ':'') + name + this.signature ?></h4>
<?js if (this.summary) { ?>
<p class="summary"><?js= summary ?></p>
<?js } ?>
</dt>
<dd>
<?js if (this.description) { ?>
<p class="description">
<?js= this.description ?>
</p>
<?js } ?>
<?js
if (this['this']) {
print('<h5>This:</h5>');
print( '<ul><li>'+linkto(this['this'], this['this'])+'</li></ul>' );
}
?>
<?js
if (this.params && params.length) {
print('<h5>Parameters:</h5>');
print( render('params.tmpl', params) );
}
?>
<?js print(render('details.tmpl', this)); ?>
<?js if (this.fires && fires.length) { ?>
<h5>Fires:</h5>
<ul><?js
fires.forEach(function(f) {
print( render('fires.tmpl', linkto(f) ) );
});
?></ul>
<?js } ?>
<?js if (this.exceptions && exceptions.length) { ?>
<h5>Throws:</h5>
<?js if (exceptions.length > 1) { ?><ul><?js
exceptions.forEach(function(r) {
print( '<li>' + render('exceptions.tmpl', r) + '</li>' );
});
?></ul><?js } else {
exceptions.forEach(function(r) {
print( render('exceptions.tmpl', r) );
});
} } ?>
<?js if (this.returns && returns.length) { ?>
<h5>Returns:</h5>
<?js if (returns.length > 1) { ?><ul><?js
returns.forEach(function(r) {
print( '<li>' + render('returns.tmpl', r) + '</li>' );
});
?></ul><?js } else {
returns.forEach(function(r) {
print( render('returns.tmpl', r) );
});
} } ?>
<?js
if (this.examples && examples.length) {
print('<h5>Example' + (examples.length > 1? 's':'') + '</h5>');
print( render('examples.tmpl', examples) );
}
?>
</dd>