Merge pull request microsoft#963 from natalieethell/addUIDsToExtends

pgonzal · web-flow · commit 8d0fcab4b7e5 · 2018-11-27T16:55:32.000-08:00
[api-documenter] fix _getTypeNameWithDot and link implements and extends to uid
diff --git a/apps/api-documenter/src/yaml/YamlDocumenter.ts b/apps/api-documenter/src/yaml/YamlDocumenter.ts
@@ -314,11 +314,11 @@ export class YamlDocumenter {
     const apiStructure: IApiClass | IApiInterface = docItem.apiItem as IApiClass | IApiInterface;
 
     if (apiStructure.extends) {
-      yamlItem.extends = [ apiStructure.extends ];
+      yamlItem.extends = [ this._linkToUidIfPossible(apiStructure.extends) ];
     }
 
     if (apiStructure.implements) {
-      yamlItem.implements = [ apiStructure.implements ];
+      yamlItem.implements = [ this._linkToUidIfPossible(apiStructure.implements) ];
     }
 
     if (apiStructure.isSealed) {
@@ -547,7 +547,7 @@ export class YamlDocumenter {
     if (hierarchy.length > 0 && hierarchy[0].kind === DocItemKind.Package) {
       hierarchy.shift(); // ignore the package qualifier
     }
-    if (hierarchy.length < 1) {
+    if (hierarchy.length < 2) {
       return undefined;
     }
     return hierarchy.map(x => x.name).join('.');
diff --git a/common/changes/@microsoft/api-documenter/addUIDsToExtends_2018-11-27-23-57.json b/common/changes/@microsoft/api-documenter/addUIDsToExtends_2018-11-27-23-57.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "add uid to implements and extends blocks, fix uid references",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "naethell@microsoft.com"
+}

Original file line number	Diff line number	Diff line change
`@@ -314,11 +314,11 @@ export class YamlDocumenter {`
`314`	`314`	`const apiStructure: IApiClass \| IApiInterface = docItem.apiItem as IApiClass \| IApiInterface;`
`315`	`315`
`316`	`316`	`if (apiStructure.extends) {`
`317`		`- yamlItem.extends = [ apiStructure.extends ];`
	`317`	`+ yamlItem.extends = [ this._linkToUidIfPossible(apiStructure.extends) ];`
`318`	`318`	`}`
`319`	`319`
`320`	`320`	`if (apiStructure.implements) {`
`321`		`- yamlItem.implements = [ apiStructure.implements ];`
	`321`	`+ yamlItem.implements = [ this._linkToUidIfPossible(apiStructure.implements) ];`
`322`	`322`	`}`
`323`	`323`
`324`	`324`	`if (apiStructure.isSealed) {`
`@@ -547,7 +547,7 @@ export class YamlDocumenter {`
`547`	`547`	`if (hierarchy.length > 0 && hierarchy[0].kind === DocItemKind.Package) {`
`548`	`548`	`hierarchy.shift(); // ignore the package qualifier`
`549`	`549`	`}`
`550`		`- if (hierarchy.length < 1) {`
	`550`	`+ if (hierarchy.length < 2) {`
`551`	`551`	`return undefined;`
`552`	`552`	`}`
`553`	`553`	`return hierarchy.map(x => x.name).join('.');`