use phpDocumentor for API docs

.github/workflows/phpdoc.yml

@@ -0,0 +1,36 @@
+name: PhpDocumentor
+
+on:
+  workflow_run:
+    workflows: ["Unit Tests"]
+    branches: [master]
+    types:
+      - completed
+
+jobs:
+  PHPDoc:
+    #if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.4
+
+      - name: Generate Docs
+        run: |
+          wget -q https://phpdoc.org/phpDocumentor.phar
+          chmod +x phpDocumentor.phar
+          ./phpDocumentor.phar -d src -t docs --visibility public,protected --title $GITHUB_REPOSITORY
+
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs # The folder the action should deploy.
+          CLEAN: true # Automatically remove deleted files from the deploy branch
+

README.md

@@ -40,6 +40,8 @@ try {
 }
 ```
 
+Please also check the [API Docs](https://splitbrain.github.io/slika/) for details.
+
 ## Operations 
 
 ### resize

src/Adapter.php

@@ -3,7 +3,9 @@
 
 namespace splitbrain\slika;
 
-
+/**
+ * Base class for image adapters. Defines what image processing adapters need to provide
+ */
 abstract class Adapter
 {
     /** @var string path tot he image */

src/Exception.php

@@ -3,7 +3,9 @@
 
 namespace splitbrain\slika;
 
-
+/**
+ * Exception thrown on all errors during image processing
+ */
 class Exception extends \Exception
 {
 

src/GdAdapter.php

@@ -3,7 +3,9 @@
 
 namespace splitbrain\slika;
 
-
+/**
+ * Image processing adapter for PHP's libGD
+ */
 class GdAdapter extends Adapter
 {
     /** @var resource libGD image */

src/ImageMagickAdapter.php

@@ -3,7 +3,9 @@
 
 namespace splitbrain\slika;
 
-
+/**
+ * Image Processing Adapter for ImageMagick's command line utility `convert`
+ */
 class ImageMagickAdapter extends Adapter
 {
     /** @var array the CLI arguments to run imagemagick */

src/Slika.php

@@ -3,17 +3,19 @@
 
 namespace splitbrain\slika;
 
-
+/**
+ * Factory to process an image using an available Adapter
+ */
 class Slika
 {
-    /** @var int rotate an image counter clock wise */
+    /** rotate an image counter clock wise */
     const ROTATE_CCW = 8;
-    /** @var int rotate an image clock wise */
+    /** rotate an image clock wise */
     const ROTATE_CW = 6;
-    /** @var int rotate on it's head */
+    /** rotate on it's head */
     const ROTATE_TOPDOWN = 3;
 
-
+    /** these can be overwritten using the options array in run() */
     const DEFAULT_OPTIONS = [
         'quality' => 92,
         'imconvert' => '/usr/bin/convert',