Update the Markdown generator to support the @eventproperty tag

pgonzal · pgonzal · commit 604db0448ee2 · 2018-06-30T11:51:54.000-07:00
diff --git a/apps/api-documenter/src/markdown/MarkdownDocumenter.ts b/apps/api-documenter/src/markdown/MarkdownDocumenter.ts
@@ -21,7 +21,8 @@ import {
   IMarkupTable,
   Markup,
   MarkupBasicElement,
-  MarkupStructuredElement
+  MarkupStructuredElement,
+  IMarkupTableRow
 } from '@microsoft/api-extractor';
 
 import {
@@ -202,6 +203,13 @@ export class MarkdownDocumenter {
       Markup.createTextElements('Description')
     ]);
 
+    const eventsTable: IMarkupTable = Markup.createTable([
+      Markup.createTextElements('Property'),
+      Markup.createTextElements('Access Modifier'),
+      Markup.createTextElements('Type'),
+      Markup.createTextElements('Description')
+    ]);
+
     const methodsTable: IMarkupTable = Markup.createTable([
       Markup.createTextElements('Method'),
       Markup.createTextElements('Access Modifier'),
@@ -220,14 +228,18 @@ export class MarkdownDocumenter {
               docMember.getApiReference())
           ];
 
-          propertiesTable.rows.push(
-            Markup.createTableRow([
-              propertyTitle,
-              [],
-              [Markup.createCode(apiMember.type, 'javascript')],
-              apiMember.summary
-            ])
-          );
+          const row: IMarkupTableRow = Markup.createTableRow([
+            propertyTitle,
+            [],
+            [Markup.createCode(apiMember.type, 'javascript')],
+            apiMember.summary
+          ]);
+
+          if (apiMember.isEventProperty) {
+            eventsTable.rows.push(row);
+          } else {
+            propertiesTable.rows.push(row);
+          }
           this._writePropertyPage(docMember);
           break;
 
@@ -270,6 +282,11 @@ export class MarkdownDocumenter {
       }
     }
 
+    if (eventsTable.rows.length > 0) {
+      markupPage.elements.push(Markup.createHeading1('Events'));
+      markupPage.elements.push(eventsTable);
+    }
+
     if (propertiesTable.rows.length > 0) {
       markupPage.elements.push(Markup.createHeading1('Properties'));
       markupPage.elements.push(propertiesTable);
