api-morph / DescriptionTagParser

Class: DescriptionTagParser

Defined in: src/parsers/DescriptionTagParser.ts:11

描述解析器，处理 @description 标签

Extends

• TagParser

Constructors

Constructor

new DescriptionTagParser(context): DescriptionTagParser

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

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

DescriptionTagParser

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/DescriptionTagParser.ts:12

解析器支持的 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/DescriptionTagParser.ts:19

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<OperationData>

解析结果。

Overrides

TagParser.parse