silverslice/markdown-api

Markdown documentation generator

Tiny library for generating API documentation for your class

Install

composer require silverslice/markdown-api, _(*1)

Live example

require __DIR__ . '/../vendor/autoload.php';

$g = new Silverslice\MarkdownApi\Generator();
$g->generate('Silverslice\MarkdownApi\Generator')->output();

This code generates following documentation for class \Silverslice\MarkdownApi\Generator:, _(*2)

generate

Generates markdown documentation for public methods in a specified class, _(*3)

generate($className)

Parameters: - string $className - Fully qualified class name, _(*4)

Returns: - $this, _(*5)

save

Saves generated documentation to a file, _(*6)

save($fileName)

Parameters: - string $fileName - The name of the file, _(*7)

Returns: - int - The number of bytes that were written to the file, or false on failure, _(*8)

output

Outputs generated documentation, _(*9)

output()

setTemplate

Sets file path for template of a method, _(*10)

setTemplate($file)

Parameters: - string $file - Path to the template, _(*11)

Throws:, _(*12)

• \InvalidArgumentException - If the file cannot be read