diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl index 5c149fa434..c2aa955b80 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl @@ -63,11 +63,12 @@ <section> <article> + <div class="container-overview"> <?js if (doc.kind === 'module' && doc.modules) { ?> <?js if (doc.description) { ?> <h3>Description</h3> - <p><?js= doc.description ?></p> + <div><?js= doc.description ?></div> <?js } ?> <?js doc.modules.forEach(function(module) { ?> @@ -75,7 +76,7 @@ <?js }) ?> <?js } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { ?> <h3>Description</h3> - <p><?js= doc.description ?></p> + <div><?js= doc.description ?></div> <table> <thead> <tr> @@ -84,11 +85,12 @@ </thead> <tbody> <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) { ?> <h3 class="paramHeading">Parameters</h3> <?js= self.partial('params.tmpl', doc.params) ?> <?js } ?> + </td> </tr> </tbody> </table> @@ -101,7 +103,7 @@ <?js } else { ?> <h3>Description</h3> <?js if (doc.description) { ?> - <p><?js= doc.description ?></p> + <div><?js= doc.description ?></div> <?js } ?> <?js if (doc.examples && doc.examples.length) { ?> @@ -264,6 +266,7 @@ <?js methods.forEach(function(m) { ?> <?js= self.partial('method.tmpl', m) ?> <?js }); ?> + </div> <?js } ?> <?js @@ -276,12 +279,10 @@ <?js signals.forEach(function(s) { ?> <?js= self.partial('signal.tmpl', s) ?> <?js }); ?> + </div> <?js } ?> - - </article> - - + </article> </section> <?js } ?> <?js }); ?> diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl index 0661ee3e50..afb0e9464c 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl @@ -31,113 +31,113 @@ if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvalu <?js if (data.version) {?> <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 if (data.since) {?> <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 if (data.inherited && data.inherits && !data.overrides) { ?> <p>Inherited From:</p> - <p><ul class="dummy"><li> + <div><ul class="dummy"><li> <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.overrides) { ?> <p>Overrides:</p> - <p><ul class="dummy"><li> + <div><ul class="dummy"><li> <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.implementations && data.implementations.length) { ?> <p>Implementations:</p> - <p><ul> + <div><ul> <?js data.implementations.forEach(function(impl) { ?> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.implements && data.implements.length) { ?> <p>Implements:</p> - <p><ul> + <div><ul> <?js data.implements.forEach(function(impl) { ?> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.mixes && data.mixes.length) { ?> <p>Mixes In:</p> - <p><ul> + <div><ul> <?js data.mixes.forEach(function(a) { ?> <li><?js= self.linkto(a, a) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.author && author.length) {?> <p>Author:</p> - <p> + <div> <ul><?js author.forEach(function(a) { ?> <li><?js= self.resolveAuthorLinks(a) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.copyright) {?> <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 if (data.license) {?> <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 if (data.defaultvalue) {?> <p>Default Value:</p> - <p><ul class="dummy"> - <li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> - </ul></p> + <div><ul class="dummy"> + <li><?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> + </ul></div> <?js } ?> <?js if (data.meta && self.outputSourceFiles) {?> <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) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.tutorials && tutorials.length) {?> <p>Tutorials:</p> - <p> + <div> <ul><?js tutorials.forEach(function(t) { ?> <li><?js= self.tutoriallink(t) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.see && see.length) {?> <p class="see">See:</p> - <p> + <div> <ul><?js see.forEach(function(s) { ?> <li><?js= self.linkto(s) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.todo && todo.length) {?> <p>To Do:</p> - <p> + <div> <ul><?js todo.forEach(function(t) { ?> <li><?js= t ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/example.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/example.tmpl index e1b06d0a46..ea70a150c5 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/example.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/example.tmpl @@ -29,113 +29,113 @@ if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvalu <?js if (data.version) {?> <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 if (data.since) {?> <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 if (data.inherited && data.inherits && !data.overrides) { ?> <p>Inherited From:</p> - <p><ul class="dummy"><li> + <div><ul class="dummy"><li> <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.overrides) { ?> <p>Overrides:</p> - <p><ul class="dummy"><li> + <div><ul class="dummy"><li> <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.implementations && data.implementations.length) { ?> <p>Implementations:</p> - <p><ul> + <div><ul> <?js data.implementations.forEach(function(impl) { ?> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.implements && data.implements.length) { ?> <p>Implements:</p> - <p><ul> + <div><ul> <?js data.implements.forEach(function(impl) { ?> <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.mixes && data.mixes.length) { ?> <p>Mixes In:</p> - <p><ul> + <div><ul> <?js data.mixes.forEach(function(a) { ?> <li><?js= self.linkto(a, a) ?></li> <?js }); ?> - </ul></p> + </ul></div> <?js } ?> <?js if (data.author && author.length) {?> <p>Author:</p> - <p> + <div> <ul><?js author.forEach(function(a) { ?> <li><?js= self.resolveAuthorLinks(a) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.copyright) {?> <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 if (data.license) {?> <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 if (data.defaultvalue) {?> <p>Default Value:</p> - <p><ul class="dummy"> - <li<?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> - </ul></p> + <div><ul class="dummy"> + <li><?js= defaultObjectClass ?>><?js= data.defaultvalue ?></li> + </ul></div> <?js } ?> <?js if (data.meta && self.outputSourceFiles) {?> <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) ?> - </li></ul></p> + </li></ul></div> <?js } ?> <?js if (data.tutorials && tutorials.length) {?> <p>Tutorials:</p> - <p> + <div> <ul><?js tutorials.forEach(function(t) { ?> <li><?js= self.tutoriallink(t) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.see && see.length) {?> <p class="see">See:</p> - <p> + <div> <ul><?js see.forEach(function(s) { ?> <li><?js= self.linkto(s) ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> <?js if (data.todo && todo.length) {?> <p>To Do:</p> - <p> + <div> <ul><?js todo.forEach(function(t) { ?> <li><?js= t ?></li> <?js }); ?></ul> - </p> + </div> <?js } ?> diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/members.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/members.tmpl index eef64c1f3f..c97a3f6979 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/members.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/members.tmpl @@ -16,7 +16,7 @@ var self = this; <tr> <td> <?js if (data.description) { ?> - <p><?js= data.description ?></p> + <div><?js= data.description ?></div> <?js } else { ?> <p style="color:red;"> </p> <?js } ?> diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl index 8db1df8a77..db52d8f0b5 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/method.tmpl @@ -12,8 +12,9 @@ var self = this; Returns: <span style="font-weight: normal;"> <?js returns.forEach(function(r) { ?> <?js= self.partial('returns.tmpl', r) ?> - <?js }); - } ?></span> + <?js }); ?> + </span> + <?js } ?> <?js if (data.kind === 'typedef' && data.type && data.type.names) { ?> <br />Type: <?js= self.partial('type.tmpl', data.type.names) ?> <?js } ?> @@ -24,23 +25,23 @@ var self = this; <tr> <td> <?js if (data.kind !== 'module' && !data.hideconstructor) { ?> - <p> + <div> <?js= data.description ?> <?js= this.partial('details.tmpl', data) ?> - </p> + </div> <?js } else { ?> <p style="color:red;"> </p> <?js } ?> <?js if (data.exceptions && exceptions.length) { ?> - <h3 class="subHeading">Throws:</h3> + <h3 class="subHeading">Throws</h3> <?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) { ?> - <p><?js= self.partial('exceptions.tmpl', r) ?></p> + <?js= self.partial('exceptions.tmpl', r) ?> <?js }); } } ?> diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/signal.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/signal.tmpl index 00bf7122e1..ece03b9e36 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/signal.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/signal.tmpl @@ -25,23 +25,23 @@ var self = this; <tr> <td> <?js if (data.kind !== 'module' && !data.hideconstructor) { ?> - <p> + <div> <?js= data.description ?> <?js= this.partial('details.tmpl', data) ?> - </p> + </div> <?js } else { ?> <p style="color:red;"> </p> <?js } ?> <?js if (data.exceptions && exceptions.length) { ?> - <h3 class="subHeading">Throws:</h3> + <h3 class="subHeading">Throws</h3> <?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) { ?> - <p><?js= self.partial('exceptions.tmpl', r) ?></p> + <?js= self.partial('exceptions.tmpl', r) ?> <?js }); } } ?>