From 3450af7a3d38d990864693ac6b5892203a8c8df5 Mon Sep 17 00:00:00 2001 From: milad Date: Mon, 21 May 2018 21:52:20 -0700 Subject: [PATCH] clean up --- tools/jsdoc/gravPrep.js | 62 +++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/tools/jsdoc/gravPrep.js b/tools/jsdoc/gravPrep.js index 1da0344478..d504a507fa 100644 --- a/tools/jsdoc/gravPrep.js +++ b/tools/jsdoc/gravPrep.js @@ -60,34 +60,23 @@ "Namespaces": [], "Globals": [] } - + // Html variables to be handle regex replacements const html_reg_static = /\(static\)<\/span>/g const html_reg_title = /\.+?\<\/h1\>/g; const html_reg_htmlExt = /\.html/g; const html_reg_objectHeader = /
[\s\S]+?<\/header>/; const html_reg_objectSpanNew = /
<\/h5>/; - const html_reg_brRemove = /
[\s\S]+?
/; - const html_reg_subsectionEdit = /()([\s\S]*?)(<\/h.>)/g; - const html_reg_subsectionEdit_replace = '

$2

'; const html_reg_propertiesHeaderEdit = '

Properties:

'; const html_reg_propertiesHeaderEdit_Replace = '

Properties

'; const html_reg_typeEdit = /(
Returns[\s\S]*?Type)(<\/dt[\s\S]*?type">)(.*?)(<\/span><\/dd>[\s\S]*?<\/dl>)/g; const html_reg_typeEdit_replace = '$1: $3' const html_reg_methodSize = /()/g; const html_reg_methodSize_replace = ''; - const html_reg_typeDefSize = /(\n)/g; - const html_reg_typeDefSize_replace = ''; - const html_reg_typeReturnSize = /
Type:\<\/h5>/g; - const html_reg_typeReturnSize_replace = '
Type:
'; - const html_reg_returnSize = /
Returns:<\/h5>/g; - const html_reg_returnSize_replace = '
Returns:<\/h6>'; const html_reg_findByName = '
` - const html_reg_findByArticleOpen = `
` const html_reg_findByArticleClose = `
` const html_reg_signalTitle = `

Signals

`; const html_reg_typeDefinitonsTitle = /

Type Definitions<\/h3>/; @@ -95,17 +84,10 @@ const html_reg_classDefinitonsTitle = /

Classes<\/h3>/; const html_reg_classDefinitonsTitle_replace = `

Classes

` const html_reg_firstDivClose = ``; - const html_reg_fixLinkHashIssue = /()/g; - const html_reg_fixLinkHashIssue_replace = "$1$2#$4" - const html_reg_findLinks = /()/g; - const html_reg_findLinksNoHashes = /([\s\S]+?<\/a>)/g; - const html_reg_findGeneralLinks = /()/g; - const html_reg_findClassLinks = /([\s\S]+?<\/a>)/g; const html_reg_pretty = /(
)([\s\S]*?)(<\/pre>)/g;
     const html_reg_pretty_replace = "
$2<\/pre>";
     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:
';
@@ -113,12 +95,10 @@
     const html_reg_dlClassDetails = /
<\/dl>/g
     const html_reg_typeDefType = /(
)(Type:)(<\/h5>[\s\S]*?)([\s\S]*?<\/ul>)/g;
     const html_reg_typeDefType_replace = `
$2 $4
`;
-    
 
 // Procedural functions
 
-// Helper Functions
-
+    // Turn links to lower case that aren't part of IDs
     function allLinksToLowerCase(match, p1, p2, p3){
             // split on id # and make sure only the preceding is lower case
             if (p2.indexOf("#") > -1){
@@ -130,6 +110,7 @@
             return [p1,p2,p3].join("");
     }
 
+    // Return the right group for where the method or type came from
     function fixLinkGrouping(match, p1, p2, p3){
         if (p2.indexOf("#") > -1){
             let split = p2.split("#");
@@ -142,20 +123,18 @@
                 let split = p2.split(".");
                 return [p1,"/api-reference/", returnRightGroup(split[1]), "/", split[1], p3].join("");
             }
-            // console.log("p2:", p2);            
             return [p1,"/api-reference/", returnRightGroup(p2), "/", p2, p3].join("");
         }
         
     }
 
     function returnRightGroup(methodToCheck){
-        // console.log("methodToCheck", methodToCheck)
         for ( var key in groupNameMemberMap ){
             for (i = 0; i < groupNameMemberMap[key].length; i++ ){
                 if (methodToCheck.toLowerCase() === groupNameMemberMap[key][i].toLowerCase()){
                     return key.toLowerCase();
                 } else {
-                    // console.log("Couldn't find group: ", methodToCheck);
+                    console.log("Couldn't find group: ", methodToCheck);
                 }
             }
         }
@@ -360,7 +339,6 @@
             }
             extractedIDs.push(id)
         })
-        // console.log("extractedIDs", extractedIDs)
         return extractedIDs;
     }
 
@@ -523,9 +501,7 @@
                                     .replace(html_reg_returnSize, html_reg_returnSize_replace) // make return size h6 instead of h5
                                     .replace(html_reg_methodSize, html_reg_methodSize_replace) // make method size into h5
                                     .replace(html_reg_pretty, html_reg_pretty_replace)
-                                    .replace(html_reg_classDefinitonsTitle, html_reg_classDefinitonsTitle_replace)
-                                    // .replace(html_reg_brRemove, "") // Remove extra Brs                                                                                                                                          
-                                    // .replace(html_reg_code, html_reg_code_replace)
+                                    .replace(html_reg_classDefinitonsTitle, html_reg_classDefinitonsTitle_replace);
             
         // Further HTML Manipulation
             // Make end term either Type Definitions or by the article
@@ -657,4 +633,30 @@
             rimraf.sync(baseMdRefDir);
         }
         copyFolderRecursiveSync(dir_md, targetMDDirectory);
-    }
\ No newline at end of file
+    }
+
+
+
+/*
+    const html_reg_subsectionEdit_replace = '
$2
';
+    const html_reg_subsectionEdit = /()([\s\S]*?)(<\/h.>)/g;
+    const html_reg_brRemove = /
[\s\S]+?
/;
+    const html_reg_typeDefSize = /(\n)/g;
+    const html_reg_typeDefSize_replace = '';
+    const html_reg_typeReturnSize = /
Type:\<\/h5>/g;
+    const html_reg_typeReturnSize_replace = '
Type:
';
+    const html_reg_containerOverview = `
`   
+    const html_reg_returnSize = /
Returns:<\/h5>/g;
+    const html_reg_returnSize_replace = '
Returns:<\/h6>';
+    const html_reg_findByArticleOpen = `