Forrest logo
tool overview
On this page you find all important commands for the CLI tool phpdox. If the command you are looking for is missing please ask our AI.

phpdox

phpDox is the documentation generator for PHP projects. This includes, but is not limited to, API documentation.

List of commands for phpdox:

  • phpdox:tldr:0e6c8 phpdox: Generate documentation for the current working directory.
    $ phpdox
    try on your machine
    explain this command
  • phpdox:tldr:7eef7 phpdox: Only run the documentation generator process.
    $ phpdox --generator
    try on your machine
    explain this command
  • phpdox:tldr:89619 phpdox: Generate documentation using a specific configuration file.
    $ phpdox --file ${path-to-phpdox-xml}
    try on your machine
    explain this command
  • phpdox:tldr:8c6f5 phpdox: Display an annotated skeleton configuration XML file.
    $ phpdox --skel
    try on your machine
    explain this command
  • phpdox:tldr:cc993 phpdox: Only run the metadata collection process.
    $ phpdox --collector
    try on your machine
    explain this command
tool overview