fix: don't overwrite doclet description if already present (@desc tag) (#141)

Fix #140

Author: Kocal

cypress/integration/templates/default.spec.js

@@ -16,6 +16,12 @@ describe('Template: default', () => {
       .contains('better-components/BetterCounter');
   });
 
+  it('should renders @desc properly', () => {
+    cy
+      .get('.container-overview')
+      .contains('BetterCounter component, like Counter component but better');
+  });
+
   it('should renders props correctly', () => {
     const props = [
       {
@@ -145,21 +151,21 @@ describe('Template: default', () => {
       .contains('decrement()')
       .next('.description')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line52"]', 'line 52');
+      .contains('a[href="better-components_BetterCounter.vue.html#line53"]', 'line 53');
 
     cy.get('#increment')
       .contains('increment()')
       .next('.description')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line45"]', 'line 45');
+      .contains('a[href="better-components_BetterCounter.vue.html#line46"]', 'line 46');
 
     cy.get('#showDialog')
       .contains('showDialog(counter)')
       .next('.description')
       .next('h5')
       .next('.params')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line60"]', 'line 60');
+      .contains('a[href="better-components_BetterCounter.vue.html#line61"]', 'line 61');
 
     cy.contains('created()').should('not.exist');
   });

cypress/integration/templates/docstrap.spec.js

@@ -16,6 +16,12 @@ describe('Template: docstrap', () => {
       .contains('better-components/BetterCounter');
   });
 
+  it('should renders @desc properly', () => {
+    cy
+      .get('.container-overview')
+      .contains('BetterCounter component, like Counter component but better');
+  });
+
   it('should renders props correctly', () => {
     const props = [
       {
@@ -145,21 +151,21 @@ describe('Template: docstrap', () => {
       .parent()
       .next('dd')
       .find('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-52"]', 'line 52');
+      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-53"]', 'line 53');
 
     cy.get('#increment')
       .contains('increment()')
       .parent()
       .next('dd')
       .find('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-45"]', 'line 45');
+      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-46"]', 'line 46');
 
     cy.get('#showDialog')
       .contains('showDialog(counter)')
       .parent()
       .next('dd')
       .find('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-60"]', 'line 60');
+      .contains('a[href="better-components_BetterCounter.vue.html#sunlight-1-line-61"]', 'line 61');
 
     cy.contains('created()').should('not.exist');
   });

cypress/integration/templates/minami.spec.js

@@ -16,6 +16,12 @@ describe('Template: minami', () => {
       .contains('better-components/BetterCounter');
   });
 
+  it('should renders @desc properly', () => {
+    cy
+      .get('.container-overview')
+      .contains('BetterCounter component, like Counter component but better');
+  });
+
   it('should renders props correctly', () => {
     const props = [
       {
@@ -146,19 +152,19 @@ describe('Template: minami', () => {
       .contains('decrement()')
       .next('.description')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line52"]', 'line 52');
+      .contains('a[href="better-components_BetterCounter.vue.html#line53"]', 'line 53');
 
     cy.get('#increment')
       .contains('increment()')
       .next('.description')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line45"]', 'line 45');
+      .contains('a[href="better-components_BetterCounter.vue.html#line46"]', 'line 46');
 
     cy.get('#showDialog')
       .contains('showDialog(counter)')
       .next('.description')
       .next('.details')
-      .contains('a[href="better-components_BetterCounter.vue.html#line60"]', 'line 60');
+      .contains('a[href="better-components_BetterCounter.vue.html#line61"]', 'line 61');
 
     cy.contains('created()').should('not.exist');
   });

cypress/integration/templates/tui.spec.js

@@ -20,6 +20,12 @@ describe('Template: tui', () => {
       .contains('better-components/BetterCounter');
   });
 
+  it('should renders @desc properly', () => {
+    cy
+      .get('.container-overview')
+      .contains('BetterCounter component, like Counter component but better');
+  });
+
   it('should renders props correctly', () => {
     const props = [
       {
@@ -146,15 +152,15 @@ describe('Template: tui', () => {
     cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
     cy.get('#decrement')
       .contains('decrement()')
-      .contains('a[href="better-components_BetterCounter.vue.html#line52"]', 'line 52');
+      .contains('a[href="better-components_BetterCounter.vue.html#line53"]', 'line 53');
 
     cy.get('#increment')
       .contains('increment()')
-      .contains('a[href="better-components_BetterCounter.vue.html#line45"]', 'line 45');
+      .contains('a[href="better-components_BetterCounter.vue.html#line46"]', 'line 46');
 
     cy.get('#showDialog')
       .contains('showDialog(counter)')
-      .contains('a[href="better-components_BetterCounter.vue.html#line60"]', 'line 60');
+      .contains('a[href="better-components_BetterCounter.vue.html#line61"]', 'line 61');
 
     cy.contains('created()').should('not.exist');
   });

example/src/better-components/BetterCounter.vue

@@ -12,6 +12,7 @@
 
   /**
    * @module better-components/BetterCounter
+   * @desc BetterCounter component, like Counter component but better
    * @vue-prop {Number} initialCounter
    * @vue-prop {Number} [step=1] Step
    * @vue-data {Number} counter - Current counter's value

index.js

@@ -58,7 +58,7 @@ exports.handlers = {
       render(template, data, (err, str) => {
         if (err) throw err;
 
-        e.doclet.description = str;
+        e.doclet.description = (e.doclet.description || '') + str;
       });
 
       // Remove meta for not rendering source for this doclet