doctum

Generate documentation

$ doctum update [doctum.php]

$ doctum render [doctum.php]

$ doctum update [doctum.php] --force

$ doctum update -v [doctum.php]

doctum command [options] config-file

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.

COMMAND

Operation: update, render, parse.

PHP configuration file.

Parse source and render documentation.

Render from cached parse data.

Parse source without rendering.

Force complete regeneration.

Verbose output.

Display help information.

doctum.php

Configuration file defining source directories, build paths, themes, and parsing options.

Requires PHP 7.2+. Large codebases may have slow initial parse. Configuration requires PHP knowledge. Some PHP edge cases may not parse correctly.

Doctum is a fork of Sami, originally created by Fabien Potencier (creator of Symfony). When Sami was deprecated, Doctum emerged as the community-maintained continuation, providing API documentation for PHP projects.

phpdoc(1), doxygen(1), php(1)