Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-06-16 01:40:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Fix JSDoc template HTML issues

Browse source
This commit is contained in:
David Rowe 2019-09-17 16:25:34 +12:00
parent 6a78ea1471
commit 43a0ed48fd
6 changed files with 75 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl
View file

@ -63,11 +63,12 @@
<section> <section>
<article> <article>
<div class="container-overview"> <div class="container-overview">
<?js if (doc.kind === 'module' && doc.modules) { ?> <?js if (doc.kind === 'module' && doc.modules) { ?>
<?js if (doc.description) { ?> <?js if (doc.description) { ?>
<h3>Description</h3> <h3>Description</h3>
<p><?js= doc.description ?></p> <div><?js= doc.description ?></div>
<?js } ?> <?js } ?>
<?js doc.modules.forEach(function(module) { ?> <?js doc.modules.forEach(function(module) { ?>
@ -75,7 +76,7 @@
<?js }) ?> <?js }) ?>
<?js } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { ?> <?js } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { ?>
<h3>Description</h3> <h3>Description</h3>
<p><?js= doc.description ?></p> <div><?js= doc.description ?></div>
<table> <table>
<thead> <thead>
<tr> <tr>
@ -84,11 +85,12 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code><?js= (doc.kind === 'class' ? 'new ' : '') + doc.name + (doc.signature || '') ?></code><p /> <td><code><?js= (doc.kind === 'class' ? 'new ' : '') + doc.name + (doc.signature || '') ?></code>
<?js if (doc.params) { ?> <?js if (doc.params) { ?>
<h3 class="paramHeading">Parameters</h3> <h3 class="paramHeading">Parameters</h3>
<?js= self.partial('params.tmpl', doc.params) ?> <?js= self.partial('params.tmpl', doc.params) ?>
<?js } ?> <?js } ?>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -101,7 +103,7 @@
<?js } else { ?> <?js } else { ?>
<h3>Description</h3> <h3>Description</h3>
<?js if (doc.description) { ?> <?js if (doc.description) { ?>
<p><?js= doc.description ?></p> <div><?js= doc.description ?></div>
<?js } ?> <?js } ?>
<?js if (doc.examples && doc.examples.length) { ?> <?js if (doc.examples && doc.examples.length) { ?>
@ -264,6 +266,7 @@
<?js methods.forEach(function(m) { ?> <?js methods.forEach(function(m) { ?>
<?js= self.partial('method.tmpl', m) ?> <?js= self.partial('method.tmpl', m) ?>
<?js }); ?> <?js }); ?>
</div>
<?js } ?> <?js } ?>
<?js <?js
@ -276,12 +279,10 @@
<?js signals.forEach(function(s) { ?> <?js signals.forEach(function(s) { ?>
<?js= self.partial('signal.tmpl', s) ?> <?js= self.partial('signal.tmpl', s) ?>
<?js }); ?> <?js }); ?>
</div>
<?js } ?> <?js } ?>
</article>
</article>
</section> </section>
<?js } ?> <?js } ?>
<?js }); ?> <?js }); ?>

54
tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl
View file

@ -31,113 +31,113 @@ if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvalu
<?js if (data.version) {?> <?js if (data.version) {?>
<p>Version:</p> <p>Version:</p>
<p><ul class="dummy"><li><?js= version ?></li></ul></p> <div><ul class="dummy"><li><?js= version ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.since) {?> <?js if (data.since) {?>
<p>Since:</p> <p>Since:</p>
<p><ul class="dummy"><li><?js= since ?></li></ul></p> <div><ul class="dummy"><li><?js= since ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.inherited && data.inherits && !data.overrides) { ?> <?js if (data.inherited && data.inherits && !data.overrides) { ?>
<p>Inherited From:</p> <p>Inherited From:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?> <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.overrides) { ?> <?js if (data.overrides) { ?>
<p>Overrides:</p> <p>Overrides:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?> <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.implementations && data.implementations.length) { ?> <?js if (data.implementations && data.implementations.length) { ?>
<p>Implementations:</p> <p>Implementations:</p>
<p><ul> <div><ul>
<?js data.implementations.forEach(function(impl) { ?> <?js data.implementations.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.implements && data.implements.length) { ?> <?js if (data.implements && data.implements.length) { ?>
<p>Implements:</p> <p>Implements:</p>
<p><ul> <div><ul>
<?js data.implements.forEach(function(impl) { ?> <?js data.implements.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.mixes && data.mixes.length) { ?> <?js if (data.mixes && data.mixes.length) { ?>
<p>Mixes In:</p> <p>Mixes In:</p>
<p><ul> <div><ul>
<?js data.mixes.forEach(function(a) { ?> <?js data.mixes.forEach(function(a) { ?>
<li><?js= self.linkto(a, a) ?></li> <li><?js= self.linkto(a, a) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.author && author.length) {?> <?js if (data.author && author.length) {?>
<p>Author:</p> <p>Author:</p>
<p> <div>
<ul><?js author.forEach(function(a) { ?> <ul><?js author.forEach(function(a) { ?>
<li><?js= self.resolveAuthorLinks(a) ?></li> <li><?js= self.resolveAuthorLinks(a) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.copyright) {?> <?js if (data.copyright) {?>
<p>Copyright:</p> <p>Copyright:</p>
<p><ul class="dummy"><li><?js= copyright ?></li></ul></p> <div><ul class="dummy"><li><?js= copyright ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.license) {?> <?js if (data.license) {?>
<p>License:</p> <p>License:</p>
<p><ul class="dummy"><li><?js= license ?></li></ul></p> <div><ul class="dummy"><li><?js= license ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.defaultvalue) {?> <?js if (data.defaultvalue) {?>
<p>Default Value:</p> <p>Default Value:</p>
<p><ul class="dummy"> <div><ul class="dummy">
<li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> <li><?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.meta && self.outputSourceFiles) {?> <?js if (data.meta && self.outputSourceFiles) {?>
<p>Source:</p> <p>Source:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?> <?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.tutorials && tutorials.length) {?> <?js if (data.tutorials && tutorials.length) {?>
<p>Tutorials:</p> <p>Tutorials:</p>
<p> <div>
<ul><?js tutorials.forEach(function(t) { ?> <ul><?js tutorials.forEach(function(t) { ?>
<li><?js= self.tutoriallink(t) ?></li> <li><?js= self.tutoriallink(t) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.see && see.length) {?> <?js if (data.see && see.length) {?>
<p class="see">See:</p> <p class="see">See:</p>
<p> <div>
<ul><?js see.forEach(function(s) { ?> <ul><?js see.forEach(function(s) { ?>
<li><?js= self.linkto(s) ?></li> <li><?js= self.linkto(s) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.todo && todo.length) {?> <?js if (data.todo && todo.length) {?>
<p>To Do:</p> <p>To Do:</p>
<p> <div>
<ul><?js todo.forEach(function(t) { ?> <ul><?js todo.forEach(function(t) { ?>
<li><?js= t ?></li> <li><?js= t ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>

54
tools/jsdoc/hifi-jsdoc-template/tmpl/example.tmpl
View file

@ -29,113 +29,113 @@ if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvalu
<?js if (data.version) {?> <?js if (data.version) {?>
<p>Version:</p> <p>Version:</p>
<p><ul class="dummy"><li><?js= version ?></li></ul></p> <div><ul class="dummy"><li><?js= version ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.since) {?> <?js if (data.since) {?>
<p>Since:</p> <p>Since:</p>
<p><ul class="dummy"><li><?js= since ?></li></ul></p> <div><ul class="dummy"><li><?js= since ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.inherited && data.inherits && !data.overrides) { ?> <?js if (data.inherited && data.inherits && !data.overrides) { ?>
<p>Inherited From:</p> <p>Inherited From:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?> <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.overrides) { ?> <?js if (data.overrides) { ?>
<p>Overrides:</p> <p>Overrides:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?> <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.implementations && data.implementations.length) { ?> <?js if (data.implementations && data.implementations.length) { ?>
<p>Implementations:</p> <p>Implementations:</p>
<p><ul> <div><ul>
<?js data.implementations.forEach(function(impl) { ?> <?js data.implementations.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.implements && data.implements.length) { ?> <?js if (data.implements && data.implements.length) { ?>
<p>Implements:</p> <p>Implements:</p>
<p><ul> <div><ul>
<?js data.implements.forEach(function(impl) { ?> <?js data.implements.forEach(function(impl) { ?>
<li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.mixes && data.mixes.length) { ?> <?js if (data.mixes && data.mixes.length) { ?>
<p>Mixes In:</p> <p>Mixes In:</p>
<p><ul> <div><ul>
<?js data.mixes.forEach(function(a) { ?> <?js data.mixes.forEach(function(a) { ?>
<li><?js= self.linkto(a, a) ?></li> <li><?js= self.linkto(a, a) ?></li>
<?js }); ?> <?js }); ?>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.author && author.length) {?> <?js if (data.author && author.length) {?>
<p>Author:</p> <p>Author:</p>
<p> <div>
<ul><?js author.forEach(function(a) { ?> <ul><?js author.forEach(function(a) { ?>
<li><?js= self.resolveAuthorLinks(a) ?></li> <li><?js= self.resolveAuthorLinks(a) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.copyright) {?> <?js if (data.copyright) {?>
<p>Copyright:</p> <p>Copyright:</p>
<p><ul class="dummy"><li><?js= copyright ?></li></ul></p> <div><ul class="dummy"><li><?js= copyright ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.license) {?> <?js if (data.license) {?>
<p>License:</p> <p>License:</p>
<p><ul class="dummy"><li><?js= license ?></li></ul></p> <div><ul class="dummy"><li><?js= license ?></li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.defaultvalue) {?> <?js if (data.defaultvalue) {?>
<p>Default Value:</p> <p>Default Value:</p>
<p><ul class="dummy"> <div><ul class="dummy">
<li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> <li><?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li>
</ul></p> </ul></div>
<?js } ?> <?js } ?>
<?js if (data.meta && self.outputSourceFiles) {?> <?js if (data.meta && self.outputSourceFiles) {?>
<p>Source:</p> <p>Source:</p>
<p><ul class="dummy"><li> <div><ul class="dummy"><li>
<?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?> <?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
</li></ul></p> </li></ul></div>
<?js } ?> <?js } ?>
<?js if (data.tutorials && tutorials.length) {?> <?js if (data.tutorials && tutorials.length) {?>
<p>Tutorials:</p> <p>Tutorials:</p>
<p> <div>
<ul><?js tutorials.forEach(function(t) { ?> <ul><?js tutorials.forEach(function(t) { ?>
<li><?js= self.tutoriallink(t) ?></li> <li><?js= self.tutoriallink(t) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.see && see.length) {?> <?js if (data.see && see.length) {?>
<p class="see">See:</p> <p class="see">See:</p>
<p> <div>
<ul><?js see.forEach(function(s) { ?> <ul><?js see.forEach(function(s) { ?>
<li><?js= self.linkto(s) ?></li> <li><?js= self.linkto(s) ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>
<?js if (data.todo && todo.length) {?> <?js if (data.todo && todo.length) {?>
<p>To Do:</p> <p>To Do:</p>
<p> <div>
<ul><?js todo.forEach(function(t) { ?> <ul><?js todo.forEach(function(t) { ?>
<li><?js= t ?></li> <li><?js= t ?></li>
<?js }); ?></ul> <?js }); ?></ul>
</p> </div>
<?js } ?> <?js } ?>

2
tools/jsdoc/hifi-jsdoc-template/tmpl/members.tmpl
View file

@ -16,7 +16,7 @@ var self = this;
<tr> <tr>
<td> <td>
<?js if (data.description) { ?> <?js if (data.description) { ?>
<p><?js= data.description ?></p> <div><?js= data.description ?></div>
<?js } else { ?> <?js } else { ?>
<p style="color:red;">&nbsp;</p> <p style="color:red;">&nbsp;</p>
<?js } ?> <?js } ?>

13
tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl
View file

@ -12,8 +12,9 @@ var self = this;
Returns: <span style="font-weight: normal;"> Returns: <span style="font-weight: normal;">
<?js returns.forEach(function(r) { ?> <?js returns.forEach(function(r) { ?>
<?js= self.partial('returns.tmpl', r) ?> <?js= self.partial('returns.tmpl', r) ?>
<?js }); <?js }); ?>
} ?></span> </span>
<?js } ?>
<?js if (data.kind === 'typedef' && data.type && data.type.names) { ?> <?js if (data.kind === 'typedef' && data.type && data.type.names) { ?>
<br />Type: <?js= self.partial('type.tmpl', data.type.names) ?> <br />Type: <?js= self.partial('type.tmpl', data.type.names) ?>
<?js } ?> <?js } ?>
@ -24,23 +25,23 @@ var self = this;
<tr> <tr>
<td> <td>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?> <?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
<p> <div>
<?js= data.description ?> <?js= data.description ?>
<?js= this.partial('details.tmpl', data) ?> <?js= this.partial('details.tmpl', data) ?>
</p> </div>
<?js } else { ?> <?js } else { ?>
<p style="color:red;">&nbsp;</p> <p style="color:red;">&nbsp;</p>
<?js } ?> <?js } ?>
<?js if (data.exceptions && exceptions.length) { ?> <?js if (data.exceptions && exceptions.length) { ?>
<h3 class="subHeading">Throws:</h3> <h3 class="subHeading">Throws</h3>
<?js if (exceptions.length > 1) { ?><ul><?js <?js if (exceptions.length > 1) { ?><ul><?js
exceptions.forEach(function(r) { ?> exceptions.forEach(function(r) { ?>
<li><?js= self.partial('exceptions.tmpl', r) ?></li> <li><?js= self.partial('exceptions.tmpl', r) ?></li>
<?js }); <?js });
?></ul><?js } else { ?></ul><?js } else {
exceptions.forEach(function(r) { ?> exceptions.forEach(function(r) { ?>
<p><?js= self.partial('exceptions.tmpl', r) ?></p> <?js= self.partial('exceptions.tmpl', r) ?>
<?js }); <?js });
} } ?> } } ?>

8
tools/jsdoc/hifi-jsdoc-template/tmpl/signal.tmpl
View file

@ -25,23 +25,23 @@ var self = this;
<tr> <tr>
<td> <td>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?> <?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
<p> <div>
<?js= data.description ?> <?js= data.description ?>
<?js= this.partial('details.tmpl', data) ?> <?js= this.partial('details.tmpl', data) ?>
</p> </div>
<?js } else { ?> <?js } else { ?>
<p style="color:red;">&nbsp;</p> <p style="color:red;">&nbsp;</p>
<?js } ?> <?js } ?>
<?js if (data.exceptions && exceptions.length) { ?> <?js if (data.exceptions && exceptions.length) { ?>
<h3 class="subHeading">Throws:</h3> <h3 class="subHeading">Throws</h3>
<?js if (exceptions.length > 1) { ?><ul><?js <?js if (exceptions.length > 1) { ?><ul><?js
exceptions.forEach(function(r) { ?> exceptions.forEach(function(r) { ?>
<li><?js= self.partial('exceptions.tmpl', r) ?></li> <li><?js= self.partial('exceptions.tmpl', r) ?></li>
<?js }); <?js });
?></ul><?js } else { ?></ul><?js } else {
exceptions.forEach(function(r) { ?> exceptions.forEach(function(r) { ?>
<p><?js= self.partial('exceptions.tmpl', r) ?></p> <?js= self.partial('exceptions.tmpl', r) ?>
<?js }); <?js });
} } ?> } } ?>