File: build/docs/base.md

Recommend this page to a friend!
  Classes of Lars Moelleken  >  PHP Readme Helper  >  build/docs/base.md  >  Download  
File: build/docs/base.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PHP Readme Helper
API documentation generator for README files
Author: By
Last change:
Date: 1 month ago
Size: 2,951 bytes
 

Contents

Class file image Download

Build Status Coverage Status Codacy Badge Latest Stable Version Total Downloads License Donate to this project using Paypal Donate to this project using Patreon

? PHP README Helper

Helper to auto-generate the API documentation in your README file.

Example

(build/generate_docs.php)

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

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

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

GenerateApi

%__functions_index__voku\PhpReadmeHelper\GenerateApi__%

%__functions_list__voku\PhpReadmeHelper\GenerateApi__%

Support

For support and donations please visit Github | Issues | PayPal | Patreon.

For status updates and release announcements please visit Releases | Twitter | Patreon.

For professional support please contact me.

Thanks

  • Thanks to GitHub (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
  • Thanks to IntelliJ as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
  • Thanks to Travis CI for being the most awesome, easiest continous integration tool out there!
  • Thanks to StyleCI for the simple but powerfull code style check.
  • Thanks to PHPStan && Psalm for really great Static analysis tools and for discover bugs in the code!

For more information send a message to info at phpclasses dot org.