From e39aecfb2aced4684c1d76b1388efd218bb8dfdb Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 28 Apr 2018 16:00:22 +1200 Subject: [PATCH 1/3] Fix custom JSDoc tags --- tools/jsdoc/plugins/hifi.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js index 7c643d398c..4a293b32f7 100644 --- a/tools/jsdoc/plugins/hifi.js +++ b/tools/jsdoc/plugins/hifi.js @@ -106,7 +106,7 @@ exports.handlers = { // Append an Available In: table at the end of the namespace description. if (rows.length > 0) { - var table = "

Available In:" + rows.join("") + "
"; + var table = "

Available in:" + rows.join("") + "
"; e.doclet.description = e.doclet.description + table; } } @@ -124,7 +124,7 @@ exports.defineTags = function (dictionary) { }); // @hifi-assignment-client - dictionary.defineTag("hifi-assigment-client", { + dictionary.defineTag("hifi-assignment-client", { onTagged: function (doclet, tag) { doclet.hifiAssignmentClient = true; } From fc4837b51c89a03a2c81f460c43671b3acdf4795 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 28 Apr 2018 16:00:49 +1200 Subject: [PATCH 2/3] Reorder listing of context tags --- tools/jsdoc/plugins/hifi.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js index 4a293b32f7..061a3fe57d 100644 --- a/tools/jsdoc/plugins/hifi.js +++ b/tools/jsdoc/plugins/hifi.js @@ -94,15 +94,15 @@ exports.handlers = { if (e.doclet.hifiInterface) { rows.push("Interface Scripts"); } - if (e.doclet.hifiAssignmentClient) { - rows.push("Assignment Client Scripts"); - } if (e.doclet.hifiClientEntity) { rows.push("Client Entity Scripts"); } if (e.doclet.hifiServerEntity) { rows.push("Server Entity Scripts"); } + if (e.doclet.hifiAssignmentClient) { + rows.push("Assignment Client Scripts"); + } // Append an Available In: table at the end of the namespace description. if (rows.length > 0) { From fada958e72288d8dea18910341d2d0482eaab0a5 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 28 Apr 2018 19:57:45 +1200 Subject: [PATCH 3/3] Handle possibly undefined value --- tools/jsdoc/plugins/hifi.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js index 061a3fe57d..5092e8b809 100644 --- a/tools/jsdoc/plugins/hifi.js +++ b/tools/jsdoc/plugins/hifi.js @@ -107,7 +107,7 @@ exports.handlers = { // Append an Available In: table at the end of the namespace description. if (rows.length > 0) { var table = "

Available in:" + rows.join("") + "
"; - e.doclet.description = e.doclet.description + table; + e.doclet.description = (e.doclet.description ? e.doclet.description : "") + table; } } }