zshelldoc

Zshelldoc is a documentation generator specifically designed for shell scripts, similar to Doxygen for other programming languages. It parses Zsh and Bash scripts to automatically produce AsciiDoc documentation, helping developers understand and maintain complex shell codebases.

Key Features

• Function Analysis — Lists all functions, including autoload functions, with their comments.
• Call Trees — Generates call graphs for functions and script bodies, supporting cross-file invocations.
• Feature Detection — Identifies features used per function (e.g., eval, read, shopt).
• Variable Tracking — Lists exported variables and tracks used exported variables with their origins.
• Hook Recognition — Marks hooks registered with add-zsh-hook in Zsh scripts.
• Custom Blocks — Supports synopsis and environment variable blocks for structured documentation.

Philosophy

Zshelldoc encourages thorough documentation of shell scripts by automating the extraction of structural and semantic information, making codebases more transparent and maintainable.