alphayax/phpdoc_md

A PHPDoc markdown documentation generator in PHP

1.2.0 2016-07-02 10:10 UTC

This package is not auto-updated.

Last update: 2024-11-09 20:39:23 UTC


README

A PHPDoc markdown documentation generator in PHP.

stable unstable pakagist

Build Status Coverage Codacy Badge

License Total Downloads

Installation

Use composer !

composer require alphayax/phpdoc_md

Usage

This example (from example) will generate a markdown documentation for classes in the given namespace :

require_once '../vendor/autoload.php';

$srcDir     = __DIR__.'/../src';
$namespace  = 'alphayax\mdGen';

$gen = new \alphayax\mdGen\MdGen( $srcDir, $namespace);
$gen->generate( 'md_gen');

Documentation

The documentation is auto-generated with this sources :)