diff options
| author | Mario <mario@mariovavti.com> | 2023-03-19 13:55:18 +0000 |
|---|---|---|
| committer | Mario <mario@mariovavti.com> | 2023-03-19 13:55:18 +0000 |
| commit | 89285f1408d21091bb80d45b391ddcbe06ba8d0f (patch) | |
| tree | b2eb07d9f3d91d77f89a4565a58e6e5231b20c1c /vendor/chillerlan/php-settings-container/docs | |
| parent | 0a679e503ef367eda3085c44af103ee53869a94f (diff) | |
| parent | 17c0bb2069dcfe35d3febc5bfdb3a7295f15d49c (diff) | |
| download | volse-hubzilla-8.2.tar.gz volse-hubzilla-8.2.tar.bz2 volse-hubzilla-8.2.zip | |
Merge branch '8.2RC'8.2
Diffstat (limited to 'vendor/chillerlan/php-settings-container/docs')
| -rw-r--r-- | vendor/chillerlan/php-settings-container/docs/Readme.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/vendor/chillerlan/php-settings-container/docs/Readme.md b/vendor/chillerlan/php-settings-container/docs/Readme.md new file mode 100644 index 000000000..7749a1e7f --- /dev/null +++ b/vendor/chillerlan/php-settings-container/docs/Readme.md @@ -0,0 +1,13 @@ +# Auto generated API documentation + +The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/). +There is an [online version available](https://chillerlan.github.io/php-settings-container/) via the [gh-pages branch](https://github.com/chillerlan/php-settings-container/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-settings-container/deployments) on each push to main. + +Locally created docs will appear in this directory. If you'd like to create local docs, please follow these steps: + +- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive +- run it in the repository root directory: + - on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml` + - on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml` +- open [index.html](./index.html) in a browser +- profit! |