PHP Classes

File: build/generate_docs.php

Recommend this page to a friend!
  Classes of Lars Moelleken   PHP Readme Helper   build/generate_docs.php   Download  
File: build/generate_docs.php
Role: Example script
Content type: text/plain
Description: Example script
Class: PHP Readme Helper
API documentation generator for README files
Author: By
Last change:
Date: 5 years ago
Size: 542 bytes
 

Contents

Class file image Download
<?php

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

$readmeGenerator = new \voku\PhpReadmeHelper\GenerateApi();

$readmeGenerator->hideTheFunctionIndex = true;

$readmeGenerator->templateMethod = <<<RAW
#### %name%
<a href="#voku-php-readme-class-methods">?</a>
%description%

**Parameters:**
%params%

**Return:**
%return%

--------
RAW;

$readmeText = ($readmeGenerator)->generate(
    __DIR__ . '/../src/voku/PhpReadmeHelper/GenerateApi.php',
    __DIR__ . '/docs/base.md'
);

file_put_contents(__DIR__ . '/../README.md', $readmeText);