xety/phpdoc-md

Parse PHP classes and writes documentation to markdown files

0.10.0 2016-10-04 08:57 UTC

This package is auto-updated.

Last update: 2020-12-04 16:07:00 UTC


README

Build Status Code Climate Test Coverage Issue Count Latest Stable Version Total Downloads License

phpdoc-md is a tool to generate nicely looking documentation from PHPDOC comments. The intention of this tool is little bit different then standard PHPDocumentator. It focus on class instances and generates documentation from public methods at first place. Whenever class inherits from some other class the full interface from parent and child will be presented as part of it but inherited methods will be placed in separate section.

phpdoc-md is configured via single .phpdoc-md.php file located in project root directory.

Example of .phpdoc-md.php file:

<?php
return (object)[
    'rootNamespace' => 'Clean\PhpDocMd\Example',
    'destDirectory' => 'docs',
    'format' => 'github',
    'classes' => [
        '\Clean\PhpDocMd\Example\Basic'
        '\Clean\PhpDocMd\Example\Deep\Foo',
        '\Clean\PhpDocMd\Example\ExtendClass',
        '\Clean\PhpDocMd\Example\ExtendExtendClass',
    ],
];

You can see an example documentation generated by this tool in here