PHPDoc PDF Output Generator: Create PDF files from PHP sources with PHPDoc

Recommend this page to a friend!
  Info   Documentation   Screenshots   View files (21)   Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 215 All time: 8,160 This week: 248
Version License PHP version Categories
phpdoc2pdf 1.0.0Custom (specified...5PHP 5, Files and Folders, Project Man...
Description Author

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.

Innovation Award
PHP Programming Innovation award nominee
August 2019
Number 3
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.


Manuel Lemos
Picture of Lluís Camino
  Performance   Level  
Name: Lluís Camino <contact>
Classes: 2 packages by
Country: Spain Spain
Age: ???
All time rank: 3838100 in Spain Spain
Week rank: 771 25 in Spain Spain
Innovation award
Innovation award
Nominee: 1x

Details

phpDoc2pdf

Scrutinizer Code Quality Build Status

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.

Installing

  1. Download the PHAR file directly from here.

Usage

Use the following command to generate the documentation:

php phpDoc2pdf.phar create <INPUT> <OUTPUT>

Replace `<INPUT>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.

Built With

Contributing

All contributions are welcome, please see the To-do list below or suggest something. ?

To-do list

  • [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.

License

This project is licensed under the MIT License - see the LICENSE file for details

Screenshots  
  • phpdoc2pdfexampleoutput.png
  Files  
File Role Description
docs (4 files)
src (2 directories)
templates (1 directory)
tests (2 files)
composer.json Data Auxiliary data
composer.lock Data Auxiliary data
LICENSE Lic. License text
README.md Doc. Documentation

  Files  /  docs  
File Role Description
   Command.pdf Data Auxiliary data
   CreateDocsCommand.pdf Data Auxiliary data
   FilesTreatment.pdf Data Auxiliary data
   PDFFile.pdf Data Auxiliary data

  Files  /  src  
File Role Description
application (4 files)
create_documentation (1 file)

  Files  /  src  /  application  
File Role Description
   Command.php Class Class source
   createDocs.php Example Example script
   CreateDocsCommand.php Class Class source
   FilesTreatment.php Class Class source

  Files  /  src  /  create_documentation  
File Role Description
   PDFFile.php Class Class source

  Files  /  templates  
File Role Description
default (6 files)

  Files  /  templates  /  default  
File Role Description
   constants.php Example Example script
   header.php Example Example script
   methods.php Example Example script
   properties.php Example Example script
   styles.css Data Auxiliary data
   summary.php Aux. Auxiliary script

  Files  /  tests  
File Role Description
   FilesTreatmentTest.php Class Class source
   PDFFileTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 95%
Total:215
This week:0
All time:8,160
This week:248

For more information send a message to info at phpclasses dot org.