library php-markdown-docs

diversen/php-markdown-docs

Generate Markdown documentation from PHP source files. Useful for generating README.md for e.g. github.com

• About
• Install
• Usage (lib)
• Usage (binary)
• Class: diversen\markdownDocs
  • Properties
  • Methods
  • public classToMD
  • public getOutput

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., _(*1)

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:, _(*2)

./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., _(*3)

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., _(*4)

You can run it on any class that is autoloaded with composer autoload.php, _(*5)

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, _(*6)

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