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

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

以下代码为类 \Silverslice\MarkdownApi\Generator 生成以下文档

generate

为指定类中的公共方法生成 Markdown 文档

generate($className)

参数

string $className - 完全限定的类名

返回

$this

save

将生成的文档保存到文件中

save($fileName)

参数

string $fileName - 文件名

返回

int - 写入文件的字节数，失败时返回 false

output

输出生成的文档

output()

setTemplate

设置方法模板的文件路径

setTemplate($file)

参数

string $file - 模板路径

抛出

\InvalidArgumentException - 如果文件无法读取