api-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Generate API documentation from TypeScript/JavaScript source:

Scan exports: Find all public functions, classes, and interfaces
Extract JSDoc: Parse
```
@param
```
,
```
@returns
```
,
```
@throws
```
,
```
@example
```
annotations
Generate missing docs: Add JSDoc for undocumented public APIs
OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP:

mcp__claude-flow__hooks_worker-dispatch({ trigger: "document", scope: "api" })

Conventions:

从TypeScript/JavaScript源代码生成API文档：

扫描导出内容：查找所有公共函数、类和接口
提取JSDoc注释：解析
```
@param
```
、
```
@returns
```
、
```
@throws
```
、
```
@example
```
注解
生成缺失文档：为未编写文档的公共API添加JSDoc注释
OpenAPI规范：针对HTTP端点，生成OpenAPI 3.0定义

通过MCP调度：

mcp__claude-flow__hooks_worker-dispatch({ trigger: "document", scope: "api" })

约定：