Merge pull request microsoft#1057 from Microsoft/octogonz/ad-issue-1055

octogonz · web-flow · commit e813cac7a5db · 2019-01-30T17:33:25.000-08:00
[api-documenter] Generate docs for function parameters and return types
diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json
@@ -18,7 +18,7 @@
     "@microsoft/api-extractor": "7.0.13",
     "@microsoft/node-core-library": "3.9.0",
     "@microsoft/ts-command-line": "4.2.3",
-    "@microsoft/tsdoc": "0.12.4",
+    "@microsoft/tsdoc": "0.12.5",
     "colors": "~1.2.1",
     "js-yaml": "~3.9.1"
   },
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -184,9 +184,8 @@ export class MarkdownDocumenter {
         break;
       case ApiItemKind.Method:
       case ApiItemKind.MethodSignature:
-        this._writeParameterTables(output, apiItem as ApiParameterListMixin);
-        break;
       case ApiItemKind.Function:
+        this._writeParameterTables(output, apiItem as ApiParameterListMixin);
         break;
       case ApiItemKind.Namespace:
         this._writePackageOrNamespaceTables(output, apiItem as ApiNamespace);
diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json
@@ -33,7 +33,7 @@
   "dependencies": {
     "@microsoft/node-core-library": "3.9.0",
     "@microsoft/ts-command-line": "4.2.3",
-    "@microsoft/tsdoc": "0.12.4",
+    "@microsoft/tsdoc": "0.12.5",
     "@types/node": "8.5.8",
     "@types/z-schema": "3.16.31",
     "colors": "~1.2.1",
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.globalfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.globalfunction.md
@@ -9,3 +9,14 @@ An exported function
 ```typescript
 export declare function globalFunction(x: number): number;
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | `number` |  |
+
+<b>Returns:</b>
+
+`number`
+
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md
@@ -9,3 +9,14 @@ A function inside a namespace
 ```typescript
 function nestedFunction(x: number): number;
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | `number` |  |
+
+<b>Returns:</b>
+
+`number`
+
diff --git a/common/changes/@microsoft/api-documenter/octogonz-ad-issue-1055_2019-01-31-00-08.json b/common/changes/@microsoft/api-documenter/octogonz-ad-issue-1055_2019-01-31-00-08.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "Fix issue where docs were not generated for function parameters and return types (GitHub #1055)",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@microsoft/api-documenter/octogonz-ad-issue-1055_2019-01-31-00-12.json b/common/changes/@microsoft/api-documenter/octogonz-ad-issue-1055_2019-01-31-00-12.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "Upgrade to TSDoc 0.12.5",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@microsoft/api-extractor/octogonz-ad-issue-1055_2019-01-31-00-12.json b/common/changes/@microsoft/api-extractor/octogonz-ad-issue-1055_2019-01-31-00-12.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "Upgrade to TSDoc 0.12.5, which allows `$` in `@param` names",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor",
+  "email": "octogonz@users.noreply.github.com"
+}
diff --git a/common/config/rush/shrinkwrap.yaml b/common/config/rush/shrinkwrap.yaml
