Merge pull request #72 from Kocal/fix/71

fix: include methods in generated documentation

Author: Kocal

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## NEXT
+
+### Fixes
+
+- Fix regression on methods that are not displayed (#72)
+
 ## 2.0.0
 
 ### Features

cypress/integration/renderers/default.spec.js

@@ -99,4 +99,13 @@ describe('Renderers: default', () => {
         expect($rowChildren.eq(2).html()).to.eq('A message');
       });
   });
+
+  it('should render methods properly', () => {
+    cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
+    cy.get('#decrement').contains('decrement()');
+    cy.get('#increment').contains('increment()');
+    cy.get('#showDialog').contains('showDialog(counter)');
+
+    cy.contains('created()').should('not.exist');
+  });
 });

cypress/integration/renderers/docstrap.spec.js

@@ -99,4 +99,13 @@ describe('Renderers: docstrap', () => {
         expect($rowChildren.eq(2).html()).to.eq('A message');
       });
   });
+
+  it('should render methods properly', () => {
+    cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
+    cy.get('#decrement').contains('decrement()');
+    cy.get('#increment').contains('increment()');
+    cy.get('#showDialog').contains('showDialog(counter)');
+
+    cy.contains('created()').should('not.exist');
+  });
 });

cypress/integration/renderers/minami.spec.js

@@ -103,4 +103,13 @@ describe('Renderers: minami', () => {
         expect($rowChildren.eq(2).html()).to.eq('A message');
       });
   });
+
+  it('should render methods properly', () => {
+    cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
+    cy.get('#decrement').contains('decrement()');
+    cy.get('#increment').contains('increment()');
+    cy.get('#showDialog').contains('showDialog(counter)');
+
+    cy.contains('created()').should('not.exist');
+  });
 });

cypress/integration/renderers/tui.spec.js

@@ -99,4 +99,13 @@ describe('Renderers: tui', () => {
         expect($rowChildren.eq(2).html()).to.eq('A message');
       });
   });
+
+  it('should render methods properly', () => {
+    cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
+    cy.get('#decrement').contains('decrement()');
+    cy.get('#increment').contains('increment()');
+    cy.get('#showDialog').contains('showDialog(counter)');
+
+    cy.contains('created()').should('not.exist');
+  });
 });

index.js

@@ -38,6 +38,15 @@ exports.handlers = {
         // Remove meta for not rendering source for this doclet
         delete e.doclet.meta;
       }
+
+      if (e.doclet.kind === 'function') {
+        if (e.doclet.memberof.endsWith('.methods')) {
+          e.doclet.scope = 'instance';
+          e.doclet.memberof = e.doclet.memberof.replace(/\.methods$/, ''); // force method to be displayed
+        } else {
+          e.doclet.memberof = null; // don't include Vue hooks
+        }
+      }
     }
   },
 };