mirko-pagliai/php-doc-maker

This package is abandoned and no longer maintained. The author suggests using the php-doc-maker package instead.

A tool to generate documentation of PHP projects and libraries

1.0.2-beta3 2020-09-30 09:58 UTC

Requires

• php: >=7.2
• cakephp/collection: ^3.1|^4
• league/commonmark: ^1.4
• mirko-pagliai/php-tools: ^1.4.1
• phpdocumentor/reflection-docblock: ^5.1
• roave/better-reflection: ^4.2
• symfony/console: ^5.1
• symfony/event-dispatcher: ^5.1
• symfony/options-resolver: ^5.1
• twig/twig: ^3.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^4.0
• phpunit/phpunit: ^8.0

MIT

• Mirko Pagliai

README

php-doc-maker is a command line tool that automatically generates the documentation of your PHP project.

It requires at least PHP 7.2.

Yes, the documentation for php-doc-maker was also generated with the same and you can find it here.

Did you like this library? Its development requires a lot of time for me. Please consider the possibility of making a donation: even a coffee is enough! Thank you.

How it work

You can install the package via Composer (if you want to install the package globally, see below)

$ composer require --dev --prefer-dist mirko-pagliai/php-doc-maker

Then you can run the command (the package has been installed in vendor/mirko-pagliai/php-doc-maker):

vendor/mirko-pagliai/php-doc-maker/bin/php-doc-maker make

This is an example of output:

$ vendor/mirko-pagliai/php-doc-maker/bin/php-doc-maker make --title "My project" -t docs

Sources directory: /home/mirko/Libs/php-doc-maker/tests/test_app
Target directory: docs
====================================================================================================================================================
Founded 13 classes
Founded 6 functions
Rendered menu element
Rendered index page
Rendered functions page
Rendered class page for App\Animals\Animal
Rendered class page for App\Animals\Cat
Rendered class page for App\Animals\Dog
Rendered class page for App\Animals\Horse
Rendered class page for App\Animals\Traits\ColorsTrait
Rendered class page for App\Animals\Traits\PositionTrait
Rendered class page for App\ArrayExample
Rendered class page for App\DeprecatedClassExample
Rendered class page for App\FileArrayExample
Rendered class page for App\Vehicles\Car
Rendered class page for App\Vehicles\MotorVehicle
Rendered class page for App\Vehicles\Vehicle
Elapsed time: 4.85 seconds

Look for example at the php-doc-maker documentation, built by itself.

You can see all the available options using the --help option (or -h):

$ vendor/mirko-pagliai/php-doc-maker/bin/php-doc-maker make -h
Usage:
make [options] [--] [<source>]

Arguments:
source Path from which to read the sources. If not specified, the current directory will be used

Options:
--debug Enables debug
--no-cache Disables cache
-t, --target=TARGET Target directory where to generate the documentation. If not specified, the `output` directory will be created
--title=TITLE Title of the project. If not specified, the title will be self-determined using the name of the source directory
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Global installation

Suppose you want to use php-doc-maker for multiple projects and libraries, and therefore don't install it for each of them.

In this case, you can clone the git repository (e.g. in your user home, or elsewhere):

$ git clone [e-mail]:mirko-pagliai/php-doc-maker.git php-doc-maker
Cloning into 'php-doc-maker'...
remote: Enumerating objects: 1373, done.
remote: Counting objects: 100% (1373/1373), done.
remote: Compressing objects: 100% (637/637), done.
remote: Total 1373 (delta 817), reused 1177 (delta 621), pack-reused 0
Ricezione degli oggetti: 100% (1373/1373), 598.74 KiB | 1.58 MiB/s, done.
Risoluzione dei delta: 100% (817/817), done.

And then install the dependencies with Composer:

$ cd php-doc-maker
$ composer install

Finally, edit the .bash_aliases file (in your user home), adding an alias:

alias php-doc-maker='/home/mirko/php-doc-maker/bin/php-doc-maker make'

Now you can run the php-doc-maker command anywhere.

Versioning

For transparency and insight into our release cycle and to maintain backward compatibility, php-doc-maker will be maintained under the Semantic Versioning guidelines.