Render constructors in their own "Constructors" section, rather than in the "Methods" section

octogonz · octogonz · commit 767874a87602 · 2019-05-26T14:26:04.000-07:00
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -100,7 +100,7 @@ export class MarkdownDocumenter {
         break;
       case ApiItemKind.Constructor:
       case ApiItemKind.ConstructSignature:
-        output.appendNode(new DocHeading({ configuration, title: `${scopedName} constructor` }));
+        output.appendNode(new DocHeading({ configuration, title: scopedName }));
         break;
       case ApiItemKind.Method:
       case ApiItemKind.MethodSignature:
@@ -382,6 +382,10 @@ export class MarkdownDocumenter {
       headerTitles: [ 'Property', 'Modifiers', 'Type', 'Description' ]
     });
 
+    const constructorsTable: DocTable = new DocTable({ configuration,
+      headerTitles: [ 'Constructor', 'Modifiers', 'Description' ]
+    });
+
     const propertiesTable: DocTable = new DocTable({ configuration,
       headerTitles: [ 'Property', 'Modifiers', 'Type', 'Description' ]
     });
@@ -393,7 +397,18 @@ export class MarkdownDocumenter {
     for (const apiMember of apiClass.members) {
 
       switch (apiMember.kind) {
-        case ApiItemKind.Constructor:
+        case ApiItemKind.Constructor: {
+          constructorsTable.addRow(
+            new DocTableRow({ configuration }, [
+              this._createTitleCell(apiMember),
+              this._createModifiersCell(apiMember),
+              this._createDescriptionCell(apiMember)
+            ])
+          );
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
         case ApiItemKind.Method: {
           methodsTable.addRow(
             new DocTableRow({ configuration }, [
@@ -440,6 +455,11 @@ export class MarkdownDocumenter {
       output.appendNode(eventsTable);
     }
 
+    if (constructorsTable.rows.length > 0) {
+      output.appendNode(new DocHeading({ configuration: this._tsdocConfiguration, title: 'Constructors' }));
+      output.appendNode(constructorsTable);
+    }
+
     if (propertiesTable.rows.length > 0) {
       output.appendNode(new DocHeading({ configuration: this._tsdocConfiguration, title: 'Properties' }));
       output.appendNode(propertiesTable);
@@ -509,6 +529,7 @@ export class MarkdownDocumenter {
     for (const apiMember of apiClass.members) {
 
       switch (apiMember.kind) {
+        case ApiItemKind.ConstructSignature:
         case ApiItemKind.MethodSignature: {
           methodsTable.addRow(
             new DocTableRow({ configuration }, [
