API Docs

Generate API documentation from source code with JSDoc and OpenAPI support

majiayu000 d51d758 2 files · 1.6 KB Updated 567 repo stars

File contents

Generate API documentation from TypeScript/JavaScript source:

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

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

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage

majiayu000/claude-skill-registry-data/tree/main/api/api-docs commit d51d758e6e

Frequently asked questions

npx skillmds add majiayu000/api-docs