Linux command
doctum 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Generate documentation
doctum update [doctum.php]
Parse and render
doctum render [doctum.php]
Update and render
doctum update [doctum.php] --force
Show verbose output
doctum update -v [doctum.php]
说明
Doctum is an API documentation generator for PHP projects. It parses PHP source code and generates browsable HTML documentation with class hierarchies, method signatures, and docblock comments. The tool is a fork of Sami, providing continued maintenance and improvements. It supports modern PHP features including traits, namespaces, and type declarations. Configuration is done through PHP files allowing flexible customization. Doctum creates searchable documentation with cross-references between classes and methods, making it valuable for documenting libraries and frameworks.
参数
- update
- Parse source and render documentation.
- render
- Render from cached parse data.
- parse
- Parse source without rendering.
- --force
- Force complete regeneration.
- --only-version _VERSION_
- Restrict build to the specified version only.
- --no-progress
- Disable the progress bar.
- --ignore-parse-errors
- Ignore parse errors and exit with code 0.
- -v, --verbose
- Verbose output.
- --help
- Display help information.
FAQ
What is the doctum command used for?
Doctum is an API documentation generator for PHP projects. It parses PHP source code and generates browsable HTML documentation with class hierarchies, method signatures, and docblock comments. The tool is a fork of Sami, providing continued maintenance and improvements. It supports modern PHP features including traits, namespaces, and type declarations. Configuration is done through PHP files allowing flexible customization. Doctum creates searchable documentation with cross-references between classes and methods, making it valuable for documenting libraries and frameworks.
How do I run a basic doctum example?
Run `doctum update [doctum.php]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does update do in doctum?
Parse source and render documentation.