changes to script

Author: utkarshx

scripts/jsdoc_to_docusaurus.js

@@ -52,13 +52,13 @@ function writeToFile(filePath, frontMatterVars){
       let newYamlContent = updateFrontmatter(frontMatterContent, { "cbbaseinfo": frontMatterVars.cbbaseinfo, "cbparameters": frontMatterVars.cbparameters });
       newFileContent = originalfileContent.replace(frontMatterMatch[0], `---\n${newYamlContent}---`);
     } else {
-      const frontMatter = createFrontMatter({ name: frontMatterVars.data.name, "cblibrary": frontMatterVars.cbbaseinfo, "cbparameters": frontMatterVars.cbparameters  });
+      const frontMatter = createFrontMatter({ name: frontMatterVars.data.name, "cbbaseinfo": frontMatterVars.cbbaseinfo, "cbparameters": frontMatterVars.cbparameters  });
       newFileContent = frontMatter + originalfileContent;
     }
     fs.writeFileSync(filePath, newFileContent);
   } else {
-    const frontMatter = createFrontMatter({ name: frontMatterVars.data.name, "cblibrary": frontMatterVars.cbbaseinfo, "cbparameters": frontMatterVars.cbparameters  });
-    newFileContent = frontMatter + "<CBBaseInfo/>";
+    const frontMatter = createFrontMatter({ name: frontMatterVars.data.name, "cbbaseinfo": frontMatterVars.cbbaseinfo, "cbparameters": frontMatterVars.cbparameters  });
+    newFileContent = frontMatter + "<CBBaseInfo/> \n <CBParameters/>";
     fs.writeFileSync(filePath, newFileContent);
   }
 }
@@ -86,10 +86,20 @@ if (codeboltChild && codeboltChild.children) {
       },
       "cbparameters": {
         "parameters": [],
-        "returndata": " ",
+        "returns": {
+          "signatureTypeName": " "
+        }
       }
     }
 
+    let parameterObj = {
+      "name": " ",
+      "typeName": " ",
+      "description": " "
+    }
+
+
+
 
     if (CbProperties.type && CbProperties.type.declaration && CbProperties.type.declaration.children) {
       CbProperties.type.declaration.children.forEach(CbFunctions => {
@@ -103,11 +113,15 @@ if (codeboltChild && codeboltChild.children) {
           CbFunctions.type.declaration.signatures.forEach(signature => {
             if (signature.parameters) {
               signature.parameters.forEach(param => {
-                frontMatterVars.cbparameters.parameters.push(`${param.name}: ${param.type.name}`);
-                console.log(`${param.name}: ${param.type.name}`);
+                parameterObj = {
+                  "name": param.name,
+                  "typeName": param.type.name,
+                  "description": param.comment && param.comment.text && param.comment.text.length > 0? param.comment.text[0].text :''
+                }
+                frontMatterVars.cbparameters.parameters.push(parameterObj);
               });
             }
-            frontMatterVars.cbparameters.returndata = signature.type.name;
+            frontMatterVars.cbparameters.returns.signatureTypeName = signature.type.name;
           });
         }
 

src/components/CBBaseInfo.jsx

@@ -15,9 +15,7 @@ const CBBaseInfo = () => {
 
         return (
           <p key={key}>
-            Name: {value.name}
-            <br/>
-            Category: {value.category}
+            Description: {value.description}
           </p>
         );
         // return Object.entries(value).map(([cbkey, cbvalue]) => {

src/components/CBParameters.jsx

@@ -6,26 +6,22 @@ import useFrontMatter from './useFrontMatter';
 
 const CBParameters = () => {
   const frontMatter = useFrontMatter();
-  console.log(frontMatter)
   return (
   <div>
     {Object.entries(frontMatter).map(([key, value]) => {
-      if (key === 'cbparamters') {
-        console.log(`Key: ${key}, Value: ${value}`);
-        
+      if (key === 'cbparameters') {  
         if (value.parameters) {
           return value.parameters.map((param, index) => {
-            console.log(param.name);
+            console.log("Parameter"+param);
             return (
               <p key={index}>
-                <strong>{param.name}</strong>
+                <strong>{param}</strong>
                 <br/>
               </p>
             );
           });
         }
       }
-      
       return null;
     })}
   </div>