Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-08 20:13:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #16139 from jennaingersoll/api-docs

Browse source 
API docs formatting updates
This commit is contained in:
Shannon Romano 2019-09-12 13:09:28 -07:00 committed by GitHub
commit 6a78ea1471
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
tools/jsdoc/hifi-jsdoc-template/static/styles/jsdoc.css
View file

@ -23,7 +23,7 @@
********************************************************************/
* {
box-sizing: border-box
box-sizing: border-box;
}
html
@ -38,11 +38,12 @@ body
font-weight: 400;
color: #000000;
letter-spacing: 0.5px;
font-size: 0.95rem;
line-height: 20px;
}
p {
font-size: 0.95rem;
line-height: 20px;
}
section
@ -128,7 +129,6 @@ table {
thead {
border-color: #d8e1d9;
background:#d8e1d9;
text-align: left;
}
table tr {
@ -146,6 +146,7 @@ td {
article table thead tr th, article table tbody tr td, article table tbody tr td p {
font-size: .89rem;
line-height: 20px;
text-align: left;
}
article table thead tr th, article table tbody tr td {
@ -199,6 +200,7 @@ nav {
padding-left: 20px;
padding-right: 20px;
box-sizing: border-box;
line-height: 12px;
}
nav::-webkit-scrollbar {
@ -378,12 +380,12 @@ nav > h2 > a {
tt, code, kbd, samp {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 0.9rem;
font-size: 1.05em;
}
.name, .signature {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 0.9rem;
font-size: 1.05em;
}
img {
@ -422,7 +424,6 @@ header {
display: block;
text-align: center;
font-size: 90%;
margin-top: -20px;
}
.variation {
@ -537,7 +538,7 @@ header {
.prettyprint code
{
font-size: 0.7rem;
font-size: 0.9em;
line-height: 18px;
display: block;
padding: 4px 12px;

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

@ -92,35 +92,33 @@
</tr>
</tbody>
</table>
<?js= self.partial('details.tmpl', doc) ?>
<?js if (doc.examples && doc.examples.length) { ?>
<h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
<?js= self.partial('examples.tmpl', doc.examples) ?>
<?js } ?>
<?js } ?>
<?js } else { ?>
<h3>Description</h3>
<?js if (doc.description) { ?>
<p><?js= doc.description ?></p>
<?js } ?>
<?js
var classes = self.find({kind: 'class', memberof: doc.longname});
if (!isGlobalPage && classes && classes.length) {
?>
<h3 id="#class">Classes</h3>
<?js classes.forEach(function(c) { ?>
<p><?js= self.linkto(c.longname, c.name) ?></p>
<?js }); ?>
<?js } ?>
<?js= self.partial('details.tmpl', doc) ?>
<?js if (doc.examples && doc.examples.length) { ?>
<h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
<?js= self.partial('examples.tmpl', doc.examples) ?>
<?js } ?>
<?js
var classes = self.find({kind: 'class', memberof: doc.longname});
if (!isGlobalPage && classes && classes.length) {
?>
<h3 id="#class">Classes</h3>
<?js classes.forEach(function(c) { ?>
<p><?js= self.linkto(c.longname, c.name) ?></p>
<?js }); ?>
<?js } ?>
<?js= self.partial('details.tmpl', doc) ?>
<?js } ?>
</div>

2
tools/jsdoc/plugins/hifi.js
View file

@ -125,7 +125,7 @@ exports.handlers = {
if (rows.length > 0) {
var availableIn = "<p class='availableIn'><b>Supported Script Types:</b> " + rows.join(" &bull; ") + "</p>";
e.doclet.description = (e.doclet.description ? e.doclet.description : "") + availableIn;
e.doclet.description = availableIn + (e.doclet.description ? e.doclet.description : "");
}
}