feat: custom tags for resolver (#37)

Author: kazupon

api-docs-gen-api.md

@@ -482,7 +482,7 @@ Resolve the markdown content reference
 
 **Signature:**
 ```typescript
-export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage): string;
+export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage, customTags?: string[]): string;
 ```
 
 #### Parameters
@@ -493,6 +493,7 @@ export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiM
 | item | ApiItem | a [item](https://rushstack.io/pages/api/api-extractor-model.apiitem/) |
 | model | ApiModel | a [model](https://rushstack.io/pages/api/api-extractor-model.apimodel/) |
 | pkg | ApiPackage | a [package](https://rushstack.io/pages/api/api-extractor-model.apipackage/) |
+| customTags | string\[\] | TSDoc custom tags. This parameter is set to an array of custom tag names defined in `--tsdoc-config`. |
 
 #### Returns
 
@@ -535,7 +536,7 @@ Resolve the markdown content reference
 
 **Signature:**
 ```typescript
-export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage): string;
+export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage, customTags?: string[]): string;
 ```
 
 #### Parameters
@@ -546,6 +547,7 @@ export declare function resolve(style: GenerateStyle, item: ApiItem, model: ApiM
 | item | ApiItem | a [item](https://rushstack.io/pages/api/api-extractor-model.apiitem/) |
 | model | ApiModel | a [model](https://rushstack.io/pages/api/api-extractor-model.apimodel/) |
 | pkg | ApiPackage | a [package](https://rushstack.io/pages/api/api-extractor-model.apipackage/) |
+| customTags | string\[\] | TSDoc custom tags. This parameter is set to an array of custom tag names defined in `--tsdoc-config`. |
 
 #### Returns
 
@@ -612,7 +614,7 @@ Markdown reference resolver
 
 **Signature:**
 ```typescript
-export declare type ReferenceResolver = (style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage) => string;
+export declare type ReferenceResolver = (style: GenerateStyle, item: ApiItem, model: ApiModel, pkg: ApiPackage, customTags?: string[]) => string;
 ```
 
 

src/config.ts

@@ -34,6 +34,7 @@ export interface Config {
  * @param item - a {@link https://rushstack.io/pages/api/api-extractor-model.apiitem/ | item}
  * @param model - a {@link https://rushstack.io/pages/api/api-extractor-model.apimodel/ | model}
  * @param pkg - a {@link https://rushstack.io/pages/api/api-extractor-model.apipackage/ | package}
+ * @param customTags - TSDoc custom tags. This parameter is set to an array of custom tag names defined in `--tsdoc-config`.
  *
  * @returns resolved reference path
  *
@@ -43,7 +44,8 @@ export type ReferenceResolver = (
   style: GenerateStyle,
   item: ApiItem,
   model: ApiModel,
-  pkg: ApiPackage
+  pkg: ApiPackage,
+  customTags?: string[]
 ) => string
 
 /**

src/processor/utils.ts

@@ -868,7 +868,8 @@ export function getDocSectionContent(
                 style,
                 result.resolvedApiItem,
                 model,
-                pkg
+                pkg,
+                customTags
               )
               if (linkText) {
                 const encodedLinkText = escapeText(

src/resolver/multi.ts

@@ -17,6 +17,7 @@ import { GenerateStyle } from '../config'
  * @param item - a {@link https://rushstack.io/pages/api/api-extractor-model.apiitem/ | item}
  * @param model - a {@link https://rushstack.io/pages/api/api-extractor-model.apimodel/ | model}
  * @param pkg - a {@link https://rushstack.io/pages/api/api-extractor-model.apipackage/ | package}
+ * @param customTags - TSDoc custom tags. This parameter is set to an array of custom tag names defined in `--tsdoc-config`.
  *
  * @returns resolved the reference string
  *
@@ -26,7 +27,8 @@ export function resolve(
   style: GenerateStyle,
   item: ApiItem,
   model: ApiModel,
-  pkg: ApiPackage
+  pkg: ApiPackage,
+  customTags?: string[] // eslint-disable-line @typescript-eslint/no-unused-vars
 ): string {
   let baseName = ''
   const pkgName = pkg.displayName

src/resolver/toc.ts

@@ -19,6 +19,7 @@ import { GenerateStyle } from '../config'
  * @param item - a {@link https://rushstack.io/pages/api/api-extractor-model.apiitem/ | item}
  * @param model - a {@link https://rushstack.io/pages/api/api-extractor-model.apimodel/ | model}
  * @param pkg - a {@link https://rushstack.io/pages/api/api-extractor-model.apipackage/ | package}
+ * @param customTags - TSDoc custom tags. This parameter is set to an array of custom tag names defined in `--tsdoc-config`.
  *
  * @returns resolved the reference string
  *
@@ -28,7 +29,8 @@ export function resolve(
   style: GenerateStyle,
   item: ApiItem,
   model: ApiModel,
-  pkg: ApiPackage
+  pkg: ApiPackage,
+  customTags?: string[] // eslint-disable-line @typescript-eslint/no-unused-vars
 ): string {
   let baseName = ''
   for (const hierarchyItem of item.getHierarchy()) {