Ratings Unique User Downloads Download Rankings Not yet rated by the users Total: 215 All time: 8,160 This week: 248
This package can create PDF files from PHP sources with PHPDoc.
It can scan a given PHP source files or a directory with PHP project source files and extract comments in PHPDoc format that describe details of the the scanned PHP source code.
The package can generate a PDF document to present the documentation of the PHP project.
PHPDoc is a popular format for embedding information on PHP source code files to help documenting it.
This package can generate documentation of PHP source code in PDF format by extracting PHPDoc information that it may contain.
Create PDF formatted documentation for your PHP projects.
phpDoc2pdf uses the
phpDocumentor/Reflection library to extract the classes, interfaces and traits from your project and generate a set of documentation similar to the one that phpDocumentor2 provides, but in PDF format.
You can see some examples on the
docs folder. Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Download the PHAR file directly from
Use the following command to generate the documentation:
php phpDoc2pdf.phar create <INPUT> <OUTPUT>
with the PHP file or directory that you want to document and
<OUTPUT>` with the directory where the documentation will be saved.
Please note that the files you want to document have to be in UTF-8 format.
All contributions are welcome, please see the To-do list below or suggest something. ?
[x] Add tests
[x] Add markdown support
[x] Add templates system
[ ] Separate generated docs into different subdirectories
[x] Make installation and usage simpler
[ ] Include phpDocBlock types on method arguments
[ ] Add support for all type of file extensions.
This project is licensed under the MIT License - see the
LICENSE file for details
Applications that use this package
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.