aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/voku/portable-ascii/build/generate_docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/voku/portable-ascii/build/generate_docs.php')
-rw-r--r--vendor/voku/portable-ascii/build/generate_docs.php26
1 files changed, 26 insertions, 0 deletions
diff --git a/vendor/voku/portable-ascii/build/generate_docs.php b/vendor/voku/portable-ascii/build/generate_docs.php
new file mode 100644
index 000000000..c86f1f195
--- /dev/null
+++ b/vendor/voku/portable-ascii/build/generate_docs.php
@@ -0,0 +1,26 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
+
+$readmeGenerator = new \voku\PhpReadmeHelper\GenerateApi();
+$readmeGenerator->templateMethod = <<<RAW
+#### %name%
+<a href="#voku-php-readme-class-methods">↑</a>
+%description%
+
+**Parameters:**
+%params%
+
+**Return:**
+%return%
+
+--------
+
+RAW;
+$readmeText = ($readmeGenerator)->generate(
+ __DIR__ . '/../src/voku/helper/ASCII.php',
+ __DIR__ . '/docs/base.md'
+);
+
+file_put_contents(__DIR__ . '/../README.md', $readmeText);