Use jsdoc-style comments for all descriptions. No single line comments for descriptions

Author: darcyparker

src/TsTypes.ts

@@ -201,16 +201,13 @@ export namespace TsType {
           if (settings.endPropertyWithSemicolon)
             decl += ';'
 
-          //Single line description in comment to the right of declaration
-          //Multiple line description in comment above
+          //All descriptions will be inside jsdoc-style comments to support hinting in editors
+          //(ie intellisense)
           if (settings.propertyDescription && _.type.description && !_.type.id)
-            decl = newLineRegex.test(_.type.description) ?
-              _.type.description
+            decl = _.type.description
                 .split(newLineRegex)
-                .map((line, lineNum) => indentString + (lineNum > 0 ? multiLineCommentIndent : multiLineCommentStart) + line)
-                .join('\n') +
-                '\n' + indentString + multiLineCommentEnd + '\n' + decl :
-              decl + ' // ' + _.type.description
+                .map((line, lineNum, lines) => (lineNum > 0 ? multiLineCommentIndent : indentString + multiLineCommentStart) + line)
+                .join('\n' + indentString) + multiLineCommentEnd + '\n' + decl
 
           return decl
         }).join('\n')}

test/cases/basics.ts

@@ -34,7 +34,8 @@ export var configurations = [
     types: `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   height?: number;
   favoriteFoods?: any[];
   likesDogs?: boolean;

test/cases/not-extendable.ts

@@ -21,5 +21,6 @@ export var schema = {
 export var types = `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
 }`

test/cases/ref.ts

@@ -19,7 +19,8 @@ export var configurations = [
     types: `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   height?: number;
   favoriteFoods?: any[];
   likesDogs?: boolean;
@@ -37,4 +38,4 @@ export interface Referencing {
   foo: ExampleSchema;
 }`
   }
-]
+]

test/cases/with-description-newlines.ts

@@ -21,11 +21,11 @@ export var schema = {
 
 export var types = `/** My cool schema */
 export interface ExampleSchema {
-  firstName: string; // first name single line description
+  /** first name single line description */
+  firstName: string;
   lastName: string;
   /** Age description with
-   *  multiple lines
-   */
+   *  multiple lines */
   age?: number;
   [k: string]: any;
 }`

test/cases/with-description.ts

@@ -22,6 +22,7 @@ export var types = `/** My cool schema */
 export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   [k: string]: any;
 }`