Skip to content

Instantly share code, notes, and snippets.

@ValeriiVasyliev

ValeriiVasyliev/phpdoc.md

Last active May 18, 2021 08:10
Show Gist options
  • Save ValeriiVasyliev/dbb1ac22c82aeba3966a25d020675db7 to your computer and use it in GitHub Desktop.
Save ValeriiVasyliev/dbb1ac22c82aeba3966a25d020675db7 to your computer and use it in GitHub Desktop.
Download ZIP
PHPDoc Create
Raw
phpdoc.md

Install

PEAR

pear channel-discover pear.phpdoc.org
pear install PhpDocumentor

If you have a bug, then enter in the console 3 following commands:

pear upgrade pear
pear upgrade Console_Getopt
pear upgrade Structures_Graph

PHAR

php phpDocumentor.phar -d . -t docs/api

Composer

composer require "phpdocumentor/phpdocumentor:2.*"

Uninstall

pear uninstall  phpdoc/PhpDocumentor

PhpDocumentor version:

phpdoc -V

PhpDocumentor commands list:

phpdoc -h

Get a list of all the available templates:

phpdoc template:list

Creating documentation. In the console, ente

phpdoc -d PROJECT_DIR -t DOCS_DIR --ignore "*/dir1/*,*/dir2/*"  --cache-folder CACHE_DIR

Get a list of all the available templates:

phpdoc template:list

https://phpdoc.org/docs/latest/guides/running-phpdocumentor.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment