alphayax/phpdoc_md

A PHPDoc markdown documentation generator in PHP

1.2.0 2016-07-02 10:10 UTC

Requires

• php: >=5.5.0
• mustache/mustache: ^2.10.0
• zf1/zend-reflection: ^1.12.11

Requires (Dev)

• codacy/coverage: <2.0.0
• phpunit/phpunit: ^5.4.0

MIT

• Yann Ponzoni

• phpdoc
• markdown
• Documentation generator

README

A PHPDoc markdown documentation generator in PHP.

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

• models
  • NamespaceMd
  • ClassMd
  • MethodMd
• utils
  • arrayAccessProperties
• MdGen