Auto generated API documentation

The API documentation can be auto generated with phpDocumentor. There is an online version available via the gh-pages branch that is automatically deployed 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 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 in a browser
• profit!