Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.97 KB

File metadata and controls

52 lines (33 loc) · 1.97 KB

PHPDoc Md

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 :)