Change overloadIndex to start from 1 as specified by TSDoc

octogonz · octogonz · commit 4326cdcd5e61 · 2019-06-04T21:49:52.000-07:00
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -793,7 +793,7 @@ export class MarkdownDocumenter {
       // For overloaded methods, add a suffix such as "MyClass.myMethod_2".
       let qualifiedName: string = hierarchyItem.displayName;
       if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
-        if (hierarchyItem.overloadIndex > 0) {
+        if (hierarchyItem.overloadIndex > 1) {
           qualifiedName += `_${hierarchyItem.overloadIndex}`;
         }
       }
diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts
@@ -526,7 +526,7 @@ export class YamlDocumenter {
       // For overloaded methods, add a suffix such as "MyClass.myMethod_2".
       let qualifiedName: string = hierarchyItem.displayName;
       if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
-        if (hierarchyItem.overloadIndex > 0) {
+        if (hierarchyItem.overloadIndex > 1) {
           qualifiedName += `_${hierarchyItem.overloadIndex}`;
         }
       }
diff --git a/apps/api-extractor-model/src/mixins/ApiParameterListMixin.ts b/apps/api-extractor-model/src/mixins/ApiParameterListMixin.ts
@@ -60,16 +60,21 @@ export interface ApiParameterListMixin extends ApiItem {
    *
    * ```ts
    * export namespace Versioning {
+   *   // TSDoc: Versioning.(addVersions:1)
    *   export function addVersions(x: number, y: number): number;
+   *
+   *   // TSDoc: Versioning.(addVersions:2)
    *   export function addVersions(x: string, y: string): string;
+   *
+   *   // (implementation)
    *   export function addVersions(x: number|string, y: number|string): number|string {
    *     // . . .
    *   }
    * }
    * ```
    *
    * In the above example, there are two overloaded declarations.  The overload using numbers will have
-   * `overloadIndex = 0`.  The overload using strings will have `overloadIndex = 1`.  The third declaration that
+   * `overloadIndex = 1`.  The overload using strings will have `overloadIndex = 2`.  The third declaration that
    * accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor.
    */
   readonly overloadIndex: number;
diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -724,7 +724,8 @@ export class ApiModelGenerator {
     let overloadIndex: number | undefined = this._cachedOverloadIndexesByDeclaration.get(astDeclaration);
 
     if (overloadIndex === undefined) {
-      let nextIndex: number = 0;
+      // TSDoc index selectors are positive integers counting from 1
+      let nextIndex: number = 1;
       for (const other of allDeclarations) {
         // Filter out other declarations that are not overloads.  For example, an overloaded function can also
         // be a namespace.

Original file line number	Diff line number	Diff line change
`@@ -793,7 +793,7 @@ export class MarkdownDocumenter {`
`793`	`793`	`// For overloaded methods, add a suffix such as "MyClass.myMethod_2".`
`794`	`794`	`let qualifiedName: string = hierarchyItem.displayName;`
`795`	`795`	`if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {`
`796`		`- if (hierarchyItem.overloadIndex > 0) {`
	`796`	`+ if (hierarchyItem.overloadIndex > 1) {`
`797`	`797`	qualifiedName += `_${hierarchyItem.overloadIndex}`;
`798`	`798`	`}`
`799`	`799`	`}`
Original file line number	Diff line number	Diff line change
`@@ -526,7 +526,7 @@ export class YamlDocumenter {`
`526`	`526`	`// For overloaded methods, add a suffix such as "MyClass.myMethod_2".`
`527`	`527`	`let qualifiedName: string = hierarchyItem.displayName;`
`528`	`528`	`if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {`
`529`		`- if (hierarchyItem.overloadIndex > 0) {`
	`529`	`+ if (hierarchyItem.overloadIndex > 1) {`
`530`	`530`	qualifiedName += `_${hierarchyItem.overloadIndex}`;
`531`	`531`	`}`
`532`	`532`	`}`