Skip to content

api-morph / ExternalDocsTagParser

Class: ExternalDocsTagParser

Defined in: src/parsers/ExternalDocsTagParser.ts:18

外部文档标签解析器,处理 @externalDocs 标签

Extends

Constructors

Constructor

new ExternalDocsTagParser(context): ExternalDocsTagParser

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

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

ExternalDocsTagParser

Inherited from

TagParser.constructor

Properties

context

context: ParseContext

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

解析上下文。

Inherited from

TagParser.context


tags

tags: string[]

Defined in: src/parsers/ExternalDocsTagParser.ts:19

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

Overrides

TagParser.tags

Methods

getTags()

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

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

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

Returns

(JSDocTagName | string & object)[]

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

Inherited from

TagParser.getTags


parse()

parse(tag): Promise<OperationData>

Defined in: src/parsers/ExternalDocsTagParser.ts:26

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<OperationData>

解析结果。

Overrides

TagParser.parse

基于 MIT 许可证发布