Fix up _getYamlItemName() handling of nested namespaces

octogonz · octogonz · commit 9643f62d845f · 2019-08-07T22:41:25.000-07:00
diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts
@@ -650,11 +650,46 @@ export class YamlDocumenter {
 
   private _getYamlItemName(apiItem: ApiItem): string {
     if (apiItem.parent && apiItem.parent.kind === ApiItemKind.Namespace) {
-      // For members a namespace, show the full name excluding the package part:
-      // Example: excel.Excel.Binding --> Excel.Binding
-      return apiItem.getScopedNameWithinPackage();
+      // If the immediate parent is a namespace, then add the namespaces to the name.  For example:
+      //
+      //   // Name: "N1"
+      //   export namespace N1 {
+      //     // Name: "N1.N2"
+      //     export namespace N2 {
+      //       // Name: "N1.N2.f(x,y)"
+      //       export function f(x: string, y: string): string {
+      //         return x + y;
+      //       }
+      //
+      //
+      //       // Name: "N1.N2.C"
+      //       export class C {
+      //         // Name: "member(x,y)"  <===========
+      //         public member(x: string, y: string): string {
+      //           return x + y;
+      //         }
+      //       }
+      //     }
+      //   }
+      //
+      // In the above example, "member(x, y)" does not appear as "N1.N2.C.member(x,y)" because YamlDocumenter
+      // embeds this entry in the web page for "N1.N2.C", so the container is obvious.  Whereas "N1.N2.f(x,y)"
+      // needs to be qualified because the DocFX template doesn't make pages for namespaces.  Instead, they get
+      // flattened into the package's page.
+      const nameParts: string[] = [ Utilities.getConciseSignature(apiItem) ];
+
+      for (let current: ApiItem | undefined = apiItem.parent; current; current = current.parent) {
+        if (current.kind !== ApiItemKind.Namespace) {
+          break;
+        }
+
+        nameParts.unshift(current.displayName);
+      }
+
+      return nameParts.join('.');
+    } else {
+      return Utilities.getConciseSignature(apiItem);
     }
-    return Utilities.getConciseSignature(apiItem);
   }
 
   private _getYamlFilePath(apiItem: ApiItem): string {
diff --git a/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml b/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml
@@ -44,8 +44,8 @@ items:
             - number
   - uid: 'api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1)'
     summary: A function inside a namespace
-    name: OuterNamespace.InnerNamespace.nestedFunction()
-    fullName: OuterNamespace.InnerNamespace.nestedFunction()
+    name: OuterNamespace.InnerNamespace.nestedFunction(x)
+    fullName: OuterNamespace.InnerNamespace.nestedFunction(x)
     langs:
       - typeScript
     type: function
