mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-16 16:16:40 +03:00
Joey Parrish
c2472dcffc
This adds custom CSS classes and a widget to show/hide various parts of the docs. By default, we show exported interfaces only. The user can also select "public" (all public interfaces, even those not exported), and "everything" (even private members). Issue #1259 Change-Id: Iff8f4d84658a3d19ad8f2f979ab37b256393589f
129 lines
3.4 KiB
Cheetah
129 lines
3.4 KiB
Cheetah
<?js
|
|
var data = obj;
|
|
var self = this;
|
|
|
|
var accessClass = 'access-public'; // default
|
|
if (data.access) {
|
|
accessClass = 'access-' + data.access;
|
|
}
|
|
?>
|
|
<div class="access-container <?js= accessClass ?>">
|
|
|
|
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
|
|
<?js if (data.kind === 'class') { ?>
|
|
<h2>Constructor</h2>
|
|
<?js } ?>
|
|
|
|
<?js if (data.kind !== 'namespace') { ?>
|
|
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') +
|
|
name + (data.signature || '') ?></h4>
|
|
<?js } ?>
|
|
|
|
<?js if (data.summary) { ?>
|
|
<p class="summary"><?js= summary ?></p>
|
|
<?js } ?>
|
|
<?js } ?>
|
|
|
|
<?js if (data.kind !== 'module' && data.description && !data.hideconstructor) { ?>
|
|
<div class="description">
|
|
<?js= data.description ?>
|
|
</div>
|
|
<?js } ?>
|
|
|
|
<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
|
|
<h5>Extends:</h5>
|
|
<?js= self.partial('augments.tmpl', data) ?>
|
|
<?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 && !data.hideconstructor) { ?>
|
|
<h5>Parameters:</h5>
|
|
<?js= this.partial('params.tmpl', params) ?>
|
|
<?js } ?>
|
|
|
|
<?js= this.partial('details.tmpl', data) ?>
|
|
|
|
<?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
|
|
<h5>Requires:</h5>
|
|
<ul><?js data.requires.forEach(function(r) { ?>
|
|
<li><?js= self.linkto(r) ?></li>
|
|
<?js }); ?></ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data.fires && fires.length) { ?>
|
|
<h5>Fires:</h5>
|
|
<ul><?js fires.forEach(function(f) { ?>
|
|
<li><?js= self.linkto(f) ?></li>
|
|
<?js }); ?></ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data.listens && listens.length) { ?>
|
|
<h5>Listens to Events:</h5>
|
|
<ul><?js listens.forEach(function(f) { ?>
|
|
<li><?js= self.linkto(f) ?></li>
|
|
<?js }); ?></ul>
|
|
<?js } ?>
|
|
|
|
<?js if (data.listeners && listeners.length) { ?>
|
|
<h5>Listeners of This Event:</h5>
|
|
<ul><?js listeners.forEach(function(f) { ?>
|
|
<li><?js= self.linkto(f) ?></li>
|
|
<?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.yields && yields.length) { ?>
|
|
<h5>Yields:</h5>
|
|
<?js if (yields.length > 1) { ?><ul><?js
|
|
yields.forEach(function(r) { ?>
|
|
<li><?js= self.partial('returns.tmpl', r) ?></li>
|
|
<?js });
|
|
?></ul><?js } else {
|
|
yields.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 } ?>
|
|
|
|
</div>
|