Download [//]: # (AUTO-GENERATED BY "PHP README Helper": base file -> docs/base.md)
? 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
<p id="voku-php-readme-class-methods"></p>
generate(string $codePath, string $baseDocFilePath, string[]|null $useClasses): string
<a href="#voku-php-readme-class-methods">?</a>
This method can generate API documentation with types from php code into your README file.
Parameters:
- string $codePath <p>Path to a file or a directory.</p>
- string $baseDocFilePath <p>Path to your base file for the README.</p>
- array<array-key, string>|null $useClasses <p>If used, you can specify to classes, you will use.</p>
Return:
- string <p>Return a string with the generated README.</p>
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!
|