Merge pull request #133 from docsbydoxdox/hotfix/added-missing-scope-to-methods

neogeek · web-flow · commit 52a7d1727818 · 2022-02-08T23:04:09.000-05:00
[hotfix] Added missing scope to methods
diff --git a/packages/doxdox-renderer-bootstrap/src/__snapshots__/index.test.ts.snap b/packages/doxdox-renderer-bootstrap/src/__snapshots__/index.test.ts.snap
@@ -34,6 +34,11 @@ exports[`bootstrap render 1`] = `
         position: relative;
       }
 
+      .method-scope {
+        font-size: 1.5rem;
+        color: #999;
+      }
+
       .method-permalink {
         position: absolute;
         margin-left: -1em;
@@ -57,7 +62,7 @@ exports[`bootstrap render 1`] = `
         <div class=\\"p-5 col-md-3\\">
           <p><b>directory/index.js</b></p>
 <ul class=\\"list-unstyled ml-0\\">
-<li><a href=\\"#index-js-methodname\\">methodName</a></li>
+<li><a href=\\"#index-js-methodname\\" class=\\"\\">methodName</a></li>
 </ul>
         </div>
 
@@ -69,6 +74,7 @@ exports[`bootstrap render 1`] = `
   methodName(param)
 </h2>
 
+
 <p>Method description</p>
 
 
diff --git a/packages/doxdox-renderer-bootstrap/src/index.ts b/packages/doxdox-renderer-bootstrap/src/index.ts
@@ -25,6 +25,7 @@ const renderMethod = (method: Method) => `<div class="mb-5"><a name="${
   }" class="method-permalink" aria-label="Permalink">#</a>
   ${method.fullName}
 </h2>
+${method.private ? `<p class="method-scope">private method</p>` : ''}
 
 ${method.description ? md.render(method.description) : ''}
 
@@ -67,7 +68,12 @@ ${method.returns.map(
 const renderFileNav = (file: File) => `<p><b>${file.path}</b></p>
 <ul class="list-unstyled ml-0">
 ${file.methods
-    .map(method => `<li><a href="#${method.slug}">${method.name}</a></li>`)
+    .map(
+        method =>
+            `<li><a href="#${method.slug}" class="${
+                method.private ? 'text-muted' : ''
+            }">${method.name}</a></li>`
+    )
     .join('')}
 </ul>`;
 
@@ -107,6 +113,11 @@ export default async (doc: Doc): Promise<string> => `<!DOCTYPE html>
         position: relative;
       }
 
+      .method-scope {
+        font-size: 1.5rem;
+        color: #999;
+      }
+
       .method-permalink {
         position: absolute;
         margin-left: -1em;
diff --git a/packages/doxdox-renderer-dash/src/index.ts b/packages/doxdox-renderer-dash/src/index.ts
@@ -35,6 +35,12 @@ const renderMethod = (doc: Doc, method: Method) => `<!DOCTYPE html>
 <title>${doc.name}${doc.description ? ` - ${doc.description}` : ''}</title>
 <link rel="stylesheet" href="resources/bootstrap.min.css">
 <link rel="stylesheet" href="resources/github.min.css">
+<style>
+.method-scope {
+  font-size: 1.5rem;
+  color: #999;
+}
+</style>
 </head>
 
 <body>
@@ -44,6 +50,7 @@ const renderMethod = (doc: Doc, method: Method) => `<!DOCTYPE html>
 <h2 class="method-name">
   ${method.fullName}
 </h2>
+${method.private ? `<p class="method-scope">private method</p>` : ''}
 
 ${method.description ? md.render(method.description) : ''}
 
diff --git a/packages/doxdox-renderer-pdf/src/index.ts b/packages/doxdox-renderer-pdf/src/index.ts
@@ -22,6 +22,7 @@ const renderMethod = (method: Method) => `<div class="mb-5"><a name="${
 }" />
 
 <h2 class="method-name">${method.fullName}</h2>
+${method.private ? `<p class="method-scope">private method</p>` : ''}
 
 ${method.description ? md.render(method.description) : ''}
 
@@ -101,6 +102,11 @@ export default async (doc: Doc): Promise<Buffer> => {
               .method-name {
                 position: relative;
               }
+
+              .method-scope {
+                font-size: 1.5rem;
+                color: #999;
+              }
             </style>
           </head>
           <body>
