add-docs

Automatically generate inline documentation by scanning source files to discover public functions, methods, classes, and constants missing comments. It detects language-specific styles, proposes concise doc comments, and requires explicit user confirmation before applying any edits to preserve existing documentation.

Auto-documentation works with Python Google-style docstrings, TypeScript and JavaScript JSDoc, Kotlin and Java KDoc, Go, and Rust. It detects the appropriate language-specific comment style and generates idiomatic documentation blocks for each detected public symbol.

Scan an entire repository, a specified directory, or a single file to find undocumented public symbols. The tool reads the target path, lists discovered functions and constants lacking comments, and presents a summary for review before making any changes.

Safe auto-documentation preserves existing comments by only targeting undocumented public symbols. It reads your files, identifies what is missing, and prompts for explicit confirmation before editing, ensuring no original documentation is overwritten during the generation process.

When code is too unclear for automatic docstring generation, the tool flags those specific symbols for manual review. It produces a summary report of files changed, counts of comments added, and clearly marks ambiguous symbols requiring human clarification.

The best way to add inline docs is to apply an automated tool that detects missing comments across common programming languages. It generates concise, idiomatic documentation blocks for public APIs and provides a confirmation prompt to review changes before committing edits.