I am documenting a program i built in PHP with phpDocumentor. Everything is working perfect, but the documentation shows me i have close to 100 errors because it is reading a file that i use to upload files into my server, but i didn't create. Is it possible to ignore that specific file that is giving me all the errors? This is the command that i am executing to generate the documentation file:
phpdoc run -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation
The file i'm trying to ignore is located inside the /myprogram
directory like this:
/modules/module1/uploader.php
I found some information about the use of --ignore
, but i don't know if that refers to something specific with the directories.
Is it possible to write something in the index.php
file that instructs phpDocumentor to ignore some files?
The --ignore
flag will accept a single filename (as well as directory names or glob expressions):
phpdoc run --ignore /var/www/html/myprogram/modules/module1/uploader.php -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation
Or since it will accept a partial directory, it could be shortened to:
phpdoc run --ignore modules/module1/uploader.php -d /var/www/html/myprogram/ -t /var/www/html/myprogram/documentation
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With