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).
This project assumes you have composer installed. Simply add:
"require-dev" : {
"evert/phpdoc-md" : "~0.2.0"
}
To your composer.json, and then you can simply install with:
composer install
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]
--lt [template]
This specifies the 'template' for links we're generating. By default
this is "%c.md".
--index [filename]
This specifies the 'filename' for API Index markdown file we're generating.
By default this is "ApiIndex.md".
--sort-index
Sort the api index and the methods on class level
--sort-see
Sort the see also section
--level [ component | class ]
Component level: Generate a md file for each class component ( method / const ..).
Class level: generate a md file for each class
The default behaviour is the class level
new : if level==component, then the program creates an user reference (showing just the public components)
and a developer reference (including public, protected and private components)
--protected-off
--private-off
--public-off
Disables the output of protected / private / public components
This should generate all the .md files. I'm excited to hear your feedback.
Cheers, Evert