api-morph / TagParser

Class: abstract TagParser

Defined in: src/core/TagParser.ts:16

标签解析器接口，所有标签解析器必须实现此接口

Extended by

• CallbackTagParser
• DeprecatedTagParser
• DescriptionTagParser
• ExtensionsTagParser
• ExternalDocsTagParser
• OperationIdTagParser
• OperationTagParser
• ParameterTagParser
• RequestBodyTagParser
• ResponsesExtensionsTagParser
• ResponseTagParser
• SecurityTagParser
• ServerTagParser
• SummaryTagParser
• TagsTagParser

Constructors

Constructor

new TagParser(context): TagParser

Defined in: src/core/TagParser.ts:24

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

TagParser

Properties

context

context: ParseContext

Defined in: src/core/TagParser.ts:24

解析上下文。

---

tags

abstract readonly tags: (JSDocTagName | string & object)[]

Defined in: src/core/TagParser.ts:18

解析器支持的 JSDoc 标签名称列表

Methods

getTags()

getTags(): (JSDocTagName | string & object)[]

Defined in: src/core/TagParser.ts:30

获取解析器支持的标签名称。

Returns

(JSDocTagName | string & object)[]

解析器支持的标签名称数组。

---

parse()

abstract parse(tag): OperationData | Promise<OperationData>

Defined in: src/core/TagParser.ts:39

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

OperationData | Promise<OperationData>

解析结果。