doctum
Doctum is a command-line tool that is used for generating documentation for PHP projects. It is primarily focused on generating API documentation based on the PHPDoc comments written in the source code.
With Doctum, developers can easily generate clean and professional-looking documentation for their PHP projects. It supports a variety of configuration options, allowing developers to customize the generated documentation according to their requirements. The tool can generate both HTML and Markdown-based documentation formats.
Doctum provides a built-in web server, enabling developers to preview the generated documentation in a web browser locally. It also supports versioning, allowing the documentation to be generated for different versions of the project.
In addition to API documentation, Doctum also supports rendering custom markdown files, allowing developers to include additional documentation, tutorials, or guides in their generated documentation.
Overall, Doctum is a versatile command-line tool that simplifies the documentation generation process for PHP projects, making it easier for developers to document their code and provide useful resources for other developers or users of their projects.
List of commands for doctum:
-
doctum:tldr:5960b doctum: Render a project.$ doctum rendertry on your machineexplain this command
-
doctum:tldr:76e9e doctum: Parse then render a project.$ doctum updatetry on your machineexplain this command
-
doctum:tldr:d8efa doctum: Parse and render a project using a specific configuration.$ doctum update ${path-to-config-php}try on your machineexplain this command
-
doctum:tldr:f4889 doctum: Parse and render only a specific version of a project.$ doctum update --only-version=${version}try on your machineexplain this command