(#87) Image API docs

Author: s1hofmann

Diff for: lib/image.class.ts

@@ -1,4 +1,15 @@
+/**
+ * The {@link Image} class represents generic image data
+ */
 export class Image {
+  /**
+   * {@link Image} class constructor
+   * @param width {@link Image} width in pixels
+   * @param height {@link Image} height in pixels
+   * @param data Generic {@link Image} data
+   * @param channels Amount of {@link Image} channels
+   * @param pixelDensity Object containing scale info to work with e.g. Retina display data where the reported display size and pixel size differ (Default: {scaleX: 1.0, scaleY: 1.0})
+   */
   constructor(
     public readonly width: number,
     public readonly height: number,
@@ -14,6 +25,9 @@ export class Image {
     }
   }
 
+  /**
+   * {@link hasAlphaChannel} return true if an {@link Image} has an additional (fourth) alpha channel
+   */
   public get hasAlphaChannel() {
     return this.channels > 3;
   }