diff --git a/tools/jsdoc/grav.bat b/tools/jsdoc/grav.bat index e850b27ced..8ac0e4162a 100644 --- a/tools/jsdoc/grav.bat +++ b/tools/jsdoc/grav.bat @@ -1 +1 @@ -node gravPrep true "D:\ROLC_High-Fidelity\02_Organize\O_Projects\Docs\Docs-Repo\hifi-docs-grav\user\themes\learn2" "D:\ROLC_High-Fidelity\02_Organize\O_Projects\Docs\Docs-Content\hifi-docs-grav-content" \ No newline at end of file +node gravPrep true "D:\ROLC_High-Fidelity\02_Organize\O_Projects\Docs\hifi-docs-grav\user\themes\learn2" "D:\ROLC_High-Fidelity\02_Organize\O_Projects\Docs\hifi-docs-grav-content" \ No newline at end of file diff --git a/tools/jsdoc/gravPrep.js b/tools/jsdoc/gravPrep.js index 05ded00bbc..241e099573 100644 --- a/tools/jsdoc/gravPrep.js +++ b/tools/jsdoc/gravPrep.js @@ -95,7 +95,13 @@ const html_reg_pretty_replace = "
$2<\/pre>";
const html_reg_code = /()([\s\S]*?)(<\/code>)/g;
const html_reg_code_replace = "$1$2$3";
-
+ const html_reg_availableIn = /([\s\S]+?Available in:[\s\S]+?<\/table>)/g;
+ const html_reg_findControllerPropertiesHeader = "Properties
";
+ const html_reg_findControllerCuratedList = /Functions<\/h5>[\s\S]*?
Input Recordings[\s\S]*?<\/ul>/g
+ const html_reg_findEntityMethods = /
Entity Methods:[\s\S]+?<\/ul>/g;
+ const html_reg_EntityMethodsHeader = 'Entity Methods:
';
+ const html_reg_EntityMethodsHeader_replace = 'Entity Methods
';
+
// Mapping for GroupNames and Members
let groupNameMemberMap = {
"Objects": [],
@@ -416,7 +422,7 @@
allItemToSplit.forEach( content => {
firstLine = content.split("\n")[0];
- if (firstLine.indexOf("Signal") > -1){
+ if (firstLine.indexOf("{Signal}") > -1){
signalArray.push(content);
} else if (firstLine.indexOf("span") > -1) {
if (content.indexOf("Available in:") > -1){
@@ -587,6 +593,14 @@
let classTOC = makeClassTOC(arrayToPassToClassToc);
if (groupName === "Global"){
currentContent = append(currentContent, html_reg_findByTitle, classTOC);
+ } else if (htmlTitle === "Controller") {
+ // currentContent = currentContent.replace(html_reg_availableIn, "");
+ let curatedList = currentContent.match(html_reg_findControllerCuratedList);
+ currentContent = currentContent.replace(html_reg_findControllerCuratedList, "");
+ let entityMethods = currentContent.match(html_reg_findEntityMethods);
+ currentContent = currentContent.replace(html_reg_findEntityMethods, "");
+ currentContent = append(currentContent, html_reg_firstTableClose, [classTOC, curatedList, entityMethods].join("\n"));
+ currentContent = currentContent.replace(html_reg_EntityMethodsHeader, html_reg_EntityMethodsHeader_replace);
} else {
currentContent = append(currentContent, html_reg_firstTableClose, classTOC);
}