Code Documentation Generator

Overview

Code Documentation Generator reads your source code and produces accurate, comprehensive documentation. From inline JSDoc comments to full API reference sites, this skill ensures your code is well-documented without the manual effort.

Key Features

• Inline Documentation: Analyzes function signatures, return types, and usage patterns to generate accurate JSDoc (TypeScript/JavaScript), docstrings (Python), and rustdoc (Rust) comments.
• API References: Generates structured API documentation from your codebase, organized by module with cross-references, type information, and usage examples.
• Architecture Documentation: Creates high-level architecture overviews by analyzing module dependencies, data flow patterns, and service boundaries.
• Documentation Sync: Detects when code changes make existing documentation outdated and suggests updates to keep docs accurate.

Documentation Standards

Follows established documentation conventions for each language: TSDoc for TypeScript, Google-style docstrings for Python, rustdoc conventions for Rust. Each parameter, return value, and exception is documented with types and descriptions.

Output Formats

Generates documentation compatible with TypeDoc, Sphinx, mdBook, and Docusaurus. Can produce standalone Markdown files or inline source comments depending on your workflow.