Responded to PR reviewer feedback.

microsoft · Mar 30, 2022 · 449348a · 449348a
1 parent 6165aea
commit 449348a
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 38 deletions.
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -836,12 +836,22 @@ export class MarkdownDocumenter {
 
     const parametersTable: DocTable = new DocTable({
       configuration,
-      headerTitles: ['Parameter', 'Type', 'Optional', 'Description']
+      headerTitles: ['Parameter', 'Type', 'Description']
     });
     for (const apiParameter of apiParameterListMixin.parameters) {
       const parameterDescription: DocSection = new DocSection({ configuration });
+
+      if (apiParameter.isOptional) {
+        parameterDescription.appendNodesInParagraph([
+          new DocEmphasisSpan({ configuration, italic: true }, [
+            new DocPlainText({ configuration, text: '(Optional)' })
+          ]),
+          new DocPlainText({ configuration, text: ' ' })
+        ]);
+      }
+
       if (apiParameter.tsdocParamBlock) {
-        this._appendSection(parameterDescription, apiParameter.tsdocParamBlock.content);
+        this._appendAndMergeSection(parameterDescription, apiParameter.tsdocParamBlock.content);
       }
 
       parametersTable.addRow(
@@ -854,11 +864,6 @@ export class MarkdownDocumenter {
           new DocTableCell({ configuration }, [
             this._createParagraphForTypeExcerpt(apiParameter.parameterTypeExcerpt)
           ]),
-          new DocTableCell({ configuration }, [
-            new DocParagraph({ configuration }, [
-              new DocPlainText({ configuration, text: apiParameter.isOptional ? 'Yes' : '' })
-            ])
-          ]),
           new DocTableCell({ configuration }, parameterDescription.nodes)
         ])
       );

diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -1029,7 +1029,7 @@ export class ApiModelGenerator {
       parameters.push({
         parameterName: parameter.name.getText().trim(),
         parameterTypeTokenRange,
-        isOptional: !!parameter.questionToken
+        isOptional: this._collector.typeChecker.isOptionalParameter(parameter),
       });
     }
     return parameters;

diff --git a/...ocumenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md b/...ocumenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md
@@ -14,7 +14,7 @@ constructor(x: number);
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | number |  |  |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number |  |
 
diff --git a/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md b/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md
@@ -14,10 +14,10 @@ exampleFunction(a: string, b: string): string;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  a | string |  | the first string |
-|  b | string |  | the second string |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  a | string | the first string |
+|  b | string | the second string |
 
 <b>Returns:</b>
 

diff --git a/...documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md b/...documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md
@@ -14,9 +14,9 @@ exampleFunction(x: number): number;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | number |  | the number |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number | the number |
 
 <b>Returns:</b>
 

diff --git a/...menter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md b/...menter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md
@@ -12,9 +12,9 @@ optionalParamFunction(x?: number): void;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | number | Yes |  |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

diff --git a/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md b/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md
@@ -14,10 +14,10 @@ static sumWithExample(x: number, y: number): number;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | number |  | the first number to add |
-|  y | number |  | the second number to add |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number | the first number to add |
+|  y | number | the second number to add |
 
 <b>Returns:</b>
 

diff --git a/...d-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md b/...d-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md
@@ -14,10 +14,10 @@ export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInt
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | [ExampleTypeAlias](./api-documenter-test.exampletypealias.md) |  | an API item that should get hyperlinked |
-|  y | number |  | a system type that should NOT get hyperlinked |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | [ExampleTypeAlias](./api-documenter-test.exampletypealias.md) | an API item that should get hyperlinked |
+|  y | number | a system type that should NOT get hyperlinked |
 
 <b>Returns:</b>
 

diff --git a/...-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md b/...-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md
@@ -12,9 +12,9 @@ genericReferenceMethod<T>(x: T): T;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | T |  |  |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | T |  |
 
 <b>Returns:</b>
 

diff --git a/...tc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md b/...tc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md
@@ -14,9 +14,9 @@ function nestedFunction(x: number): number;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  x | number |  |  |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number |  |
 
 <b>Returns:</b>
 

diff --git a/.../api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md b/.../api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md
@@ -14,9 +14,9 @@ addHandler(handler: () => void): void;
 
 ## Parameters
 
-|  Parameter | Type | Optional | Description |
-|  --- | --- | --- | --- |
-|  handler | () =&gt; void |  |  |
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  handler | () =&gt; void |  |
 
 <b>Returns:</b>