Merge pull request #963 from natalieethell/addUIDsToExtends

[api-documenter] fix _getTypeNameWithDot and link implements and extends to uid
microsoft · Nov 28, 2018 · 8d0fcab · 8d0fcab
2 parents 9635191 + 72cfaf7
commit 8d0fcab
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
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": "[email protected]"
+}