clean/phpdoc-md

# clean/phpdoc-md

[![Build Status](https://travis-ci.org/clean/phpdoc-md.svg?branch=master)](https://travis-ci.org/clean/phpdoc-md)
[![Code Climate](https://codeclimate.com/github/clean/phpdoc-md/badges/gpa.svg)](https://codeclimate.com/github/clean/phpdoc-md)
[![Test Coverage](https://codeclimate.com/github/clean/phpdoc-md/badges/coverage.svg)](https://codeclimate.com/github/clean/phpdoc-md/coverage)
[![Issue Count](https://codeclimate.com/github/clean/phpdoc-md/badges/issue_count.svg)](https://codeclimate.com/github/clean/phpdoc-md)
[![Latest Stable Version](https://poser.pugx.org/clean/phpdoc-md/v/stable)](https://packagist.org/packages/clean/phpdoc-md)
[![Total Downloads](https://poser.pugx.org/clean/phpdoc-md/downloads)](https://packagist.org/packages/clean/phpdoc-md)
[![License](https://poser.pugx.org/clean/phpdoc-md/license)](https://packagist.org/packages/clean/phpdoc-md)

![Image of example documentation](./example.jpg)

phpdoc-md is a tool to generate nicely looking documentation from PHPDOC comments.

It allows to generate documentation markdown files easy to read and follow 
directly on github, gitlab or bitbucket sites.

You can see an example documentation generated by this tool in [here](docs/README.md)

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. 

## How to use it?

phpdoc-md is configured via single (php format) `.phpdoc-md` file located in
your project root directory.

Example of `.phpdoc-md` 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',
    ],
];
```