evert/phpdoc-md

PHP documentation generator, with markdown output

Installs: 14 147

Dependents: 24

Stars: 75

Watchers: 6

Forks: 20

Open Issues: 3

Language: PHP

0.1.1 2015-03-26 23:24 UTC

README

This is a script that can generate markdown (.md) files for your API documentation.

It is tailored for projects using PSR-0, PSR-1, PSR-2, PSR-4 and namespaces. The project was primarily developed for sabre/dav, but it should work for other codebases as well.

It only documents classes and interfaces.

The code is ugly, it was intended as a one-off, and I was in a hurry.. so the codebase may not be up to your standards. (it certainly isn't up to mine).

Installation

This project assumes you have composer installed. Simply add:

"require-dev" : {

    "evert/phpdoc-md" : "~0.1.1"

}

To your composer.json, and then you can simply install with:

composer install

Usage

First ensure that phpdocumentor 2 is installed somewhere, after, you must generate a file called structure.xml.

The easiest is to create a temporary directory, for example named docs/.

# phpdoc command
phpdoc  -d [project path] -t docs/ --template="xml"

# Next, run phpdocmd:
phpdocmd docs/structure.xml [outputdir]

Options

--lt [template]
    This specifies the 'template' for links we're generating. By default
    this is "%c.md".

This should generate all the .md files. I'm excited to hear your feedback.

Cheers, Evert