mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
239 lines
6.5 KiB
Cheetah
239 lines
6.5 KiB
Cheetah
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: <?js= title ?></title>
|
|
|
|
<script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
|
|
<script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title"><?js= title ?></h1>
|
|
|
|
<?js
|
|
docs.forEach(function(doc, i) {
|
|
?>
|
|
|
|
<section>
|
|
|
|
<header>
|
|
<h2><?js
|
|
if (doc.ancestors && doc.ancestors.length) {
|
|
print('<span class="ancestors">');
|
|
print( doc.ancestors.join('') );
|
|
print('</span>' + doc.name);
|
|
}
|
|
else {
|
|
print(doc.name)
|
|
}
|
|
|
|
if (doc.variation) {
|
|
print('<sup class="variation">'+doc.variation+'</sup>');
|
|
}
|
|
|
|
?></h2>
|
|
<?js
|
|
if (doc.classdesc) {
|
|
print('<p class="class-description">'+doc.classdesc+'</p>');
|
|
}
|
|
?>
|
|
</header>
|
|
|
|
<article>
|
|
<div class="container-overview">
|
|
<?js
|
|
if (doc.kind === 'module' && doc.module) {
|
|
print(render('method.tmpl', doc.module));
|
|
}
|
|
|
|
if (doc.kind === 'class') {
|
|
print(render('method.tmpl', doc));
|
|
}
|
|
else {
|
|
if (doc.description) {
|
|
print('<p class="description">' + doc.description + '</p>');
|
|
}
|
|
|
|
print(render('details.tmpl', doc));
|
|
|
|
if (doc.examples && doc.examples.length) {
|
|
print('<h3>Example' + (doc.examples.length > 1? 's':'') + '</h3>');
|
|
print( render('examples.tmpl', doc.examples) );
|
|
}
|
|
}
|
|
?>
|
|
</div>
|
|
|
|
<?js
|
|
if (doc.augments && doc.augments.length) {
|
|
?>
|
|
<h3 class="subsection-title">Extends</h3>
|
|
|
|
<ul><?js
|
|
doc.augments.forEach(function(a) {
|
|
?>
|
|
<li><?js= linkto(a, a) ?></li>
|
|
<?js
|
|
});
|
|
?></ul>
|
|
<?js
|
|
}
|
|
?>
|
|
|
|
<?js
|
|
if (doc.mixes && doc.mixes.length) {
|
|
?>
|
|
<h3 class="subsection-title">Mixes In</h3>
|
|
|
|
<ul><?js
|
|
doc.mixes.forEach(function(a) {
|
|
?>
|
|
<li><?js= linkto(a, a) ?></li>
|
|
<?js
|
|
});
|
|
?></ul>
|
|
<?js
|
|
}
|
|
?>
|
|
|
|
<?js
|
|
if (doc.requires && doc.requires.length) {
|
|
?>
|
|
<h3 class="subsection-title">Requires</h3>
|
|
|
|
<ul><?js
|
|
doc.requires.forEach(function(r) {
|
|
?>
|
|
<li><?js= linkto(r, r) ?></li>
|
|
<?js
|
|
});
|
|
?></ul>
|
|
<?js
|
|
}
|
|
?>
|
|
|
|
<?js
|
|
var classes = find({kind: 'class', memberof: doc.longname});
|
|
if (doc.kind !== 'globalobj' && classes && classes.length) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">Classes</h3>
|
|
|
|
<dl><?js
|
|
classes.forEach(function(c) {
|
|
?>
|
|
<dt><?js= linkto(c.longname, c.name) ?></dt>
|
|
<dd><?js if (c.summary) print(c.summary); ?></dd>
|
|
<?js
|
|
});
|
|
?></dl>
|
|
|
|
<?js } ?>
|
|
|
|
<?js
|
|
var namespaces = find({kind: 'namespace', memberof: doc.longname});
|
|
if (doc.kind !== 'globalobj' && namespaces && namespaces.length) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">Namespaces</h3>
|
|
|
|
<dl><?js
|
|
namespaces.forEach(function(n) {
|
|
?>
|
|
<dt><a href="namespaces.html#<?js= n.longname ?>"><?js= linkto(n.longname, n.name) ?></a></dt>
|
|
<dd><?js if (n.summary) print(n.summary); ?></dd>
|
|
<?js
|
|
});
|
|
?></dl>
|
|
|
|
<?js } ?>
|
|
|
|
<?js
|
|
var members = find({kind: 'member', memberof: doc.longname});
|
|
if (title === 'Globals') {
|
|
members = find({kind: 'member', memberof: {isUndefined: true}});
|
|
}
|
|
if (members && members.length && members.forEach) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">Members</h3>
|
|
|
|
<dl><?js
|
|
members.forEach(function(p) {
|
|
print(render('members.tmpl', p));
|
|
});
|
|
?></dl>
|
|
|
|
<?js } ?>
|
|
|
|
<?js
|
|
var methods = find({kind: 'function', memberof: doc.longname});
|
|
if (title === 'Globals') {
|
|
methods = find({kind: 'function', memberof: {isUndefined: true}});
|
|
}
|
|
if (methods && methods.length && methods.forEach) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
|
|
<dl><?js
|
|
methods.forEach(function(m) {
|
|
print(render('method.tmpl', m));
|
|
});
|
|
?></dl>
|
|
|
|
<?js } ?>
|
|
|
|
<?js
|
|
var typedefs = find({kind: 'typedef', memberof: doc.longname});
|
|
if (typedefs && typedefs.length && typedefs.forEach) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">TypeDefs</h3>
|
|
|
|
<dl><?js
|
|
typedefs.forEach(function(e) {
|
|
print(render('members.tmpl', e));
|
|
});
|
|
?></dl>
|
|
<?js } ?>
|
|
|
|
<?js
|
|
var events = find({kind: 'event', memberof: doc.longname});
|
|
if (events && events.length && events.forEach) {
|
|
?>
|
|
|
|
<h3 class="subsection-title">Events</h3>
|
|
|
|
<dl><?js
|
|
events.forEach(function(e) {
|
|
print(render('method.tmpl', e));
|
|
});
|
|
?></dl>
|
|
<?js } ?>
|
|
</article>
|
|
|
|
</section>
|
|
<?js }); ?>
|
|
</div>
|
|
|
|
<nav>
|
|
<?js= nav ?>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on <?js= (new Date()) ?>
|
|
</footer>
|
|
|
|
<script> sh_highlightDocument(); </script>
|
|
</body>
|
|
</html> |