diversen / php-markdown-docs
Generate Markdown documentation from PHP source files. Useful for generating README.md for e.g. github.com
Installs: 1 297
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=5.4.0
- diversen/parse-argv: ^1.0
- nette/reflection: ^2.3
README
About
Simple and easy to use documentation system for PHP classes,
which generates Markdown output. It works easy
with e.g. github.com, as you will be able to include documentation
for your classes in README.md
files - like the one you
probably are looking at now. Best suited for small code libs
with maybe a couple of classes.
Install
composer require diversen/php-markdown-docs
Usage (lib)
use diversen\markdownDocs; $md = new markdownDocs(); // Class to be generate documentaiton for $class = 'diversen\markdownDocs'; $md->classToMD($class); echo $md->getOutput();
Usage (binary)
When the lib is installed you have access to the markdown-docs
binary, and you can
use in a way similar to this:
./vendor/bin/markdown-docs --public 'diversen\markdownDocs'
This will just output the markdown documentation to stdout
, so you will need to redirect it, e.g. to a file.
If you want both private, public, and protected
methods in the documentation, you can remove the
--public
flag. This flag means that only public
properties and methods will be included in
the output.
You can run it on any class that is autoloaded with composer
autoload.php
Class: diversen\markdownDocs
Simple class that generates markdown
from php
source files (using phpdocs format)
The real work is done through Nette\Reflection
. See: https://github.com/nette/reflection
Properties
Methods
public classToMD
Generates markdown output for a specified class
@param string $class e.g. `PDO` or a user class like `diversen\markdownDocs`
@return void the method adds to $output
public getOutput
Returns the markdown phpdocs
@return string $output the final markdown output