project-api

Auto-generate API documentation by parsing JavaScript and TypeScript source files to extract classes, functions, exports, and inheritance, then writing the structured reference to a Markdown file. This ensures your project's API reference always reflects the current codebase.

Keep API documentation up to date by using a self-healing automation workflow that detects missing or outdated reference files and regenerates them. It analyzes current source code structures during setup or pipeline execution to refresh the Markdown output.

Yes, you can integrate API reference generation into CI pipelines. The automation workflow parses JavaScript and TypeScript codebases to detect method signatures and class hierarchies, regenerating the Markdown reference automatically whenever APIs change.

Yes, the API documentation generator detects class hierarchies, method signatures, constructors, exported functions, and getters/setters. It comprehensively extracts these structures from JavaScript and TypeScript source code to build a structured Markdown reference.

The generated API reference output uses Markdown format, specifically written to the .claude/api.md file path. This structured Markdown file captures all detected classes, functions, exports, and inheritance details extracted from the source code.

Automated code analysis for API documentation may not suit projects lacking structured JavaScript or TypeScript codebases, or when custom non-standard export patterns are used. It relies on parsing standard language constructs like classes and functions to generate the Markdown reference.