location getter/setter JSDoc

This commit is contained in:
David Rowe 2018-05-15 17:37:45 +12:00
parent b7a0ff523a
commit 1ca6bd2f0b
2 changed files with 7 additions and 2 deletions

View file

@ -32,6 +32,11 @@ const QString GET_PLACE = "/api/v1/places/%1";
/**jsdoc
* The location API provides facilities related to your current location in the metaverse.
*
* <h5>Getter/Setter</h5>
* <p>You can get and set your current metaverse address by directly reading a string value from and writing a string value to
* the <code>location</code> object. This is an alternative to using the <code>location.href</code> property or this object's
* functions.</p>
*
* @namespace location
*
* @hifi-interface

View file

@ -114,8 +114,8 @@ exports.handlers = {
// Append an Available In: table at the end of the namespace description.
if (rows.length > 0) {
var table = "<br><br><table><tr><th>Available in:</th><td>" + rows.join("</td><td>") + "</td></tr></table>";
e.doclet.description = (e.doclet.description ? e.doclet.description : "") + table;
var table = "<table><tr><th>Available in:</th><td>" + rows.join("</td><td>") + "</td></tr></table><br>";
e.doclet.description = table + (e.doclet.description ? e.doclet.description : "");
}
}
}