Merge pull request #230 from squah-u/fix-default-only-jsdoc

Fix @default jsdoc annotation with no description being ignored

Author: pvasek

src/__tests__/data/StatelessWithDefaultOnlyJsDoc.tsx

@@ -0,0 +1,10 @@
+import * as React from 'react';
+
+export interface StatelessWithDefaultOnlyJsDocProps {
+  /** @default hello */
+  myProp: string;
+}
+/** StatelessWithDefaultOnlyJsDoc description */
+export const StatelessWithDefaultOnlyJsDoc: React.StatelessComponent<
+  StatelessWithDefaultOnlyJsDocProps
+> = props => <div>My Property = {props.myProp}</div>;

src/__tests__/parser.ts

@@ -468,6 +468,14 @@ describe('parser', () => {
     });
   });
 
+  it('should parse jsdocs with the @default tag and no description', () => {
+    check('StatelessWithDefaultOnlyJsDoc', {
+      StatelessWithDefaultOnlyJsDoc: {
+        myProp: { defaultValue: 'hello', description: '', type: 'string' }
+      }
+    });
+  });
+
   it('should parse functional component component defined as function', () => {
     check('FunctionDeclaration', {
       Jumbotron: {

src/parser.ts

@@ -540,15 +540,15 @@ export class Parser {
 
   public findDocComment(symbol: ts.Symbol): JSDoc {
     const comment = this.getFullJsDocComment(symbol);
-    if (comment.fullComment) {
+    if (comment.fullComment || comment.tags.default) {
       return comment;
     }
 
     const rootSymbols = this.checker.getRootSymbols(symbol);
     const commentsOnRootSymbols = rootSymbols
       .filter(x => x !== symbol)
       .map(x => this.getFullJsDocComment(x))
-      .filter(x => !!x.fullComment);
+      .filter(x => !!x.fullComment || !!comment.tags.default);
 
     if (commentsOnRootSymbols.length) {
       return commentsOnRootSymbols[0];