Added javadocs

2 files changed, 13 insertions, 0 deletions

diff --git a/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/CompatDecoderFactory.java b/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/CompatDecoderFactory.java
index d8f3d1f..e7255a0 100644
--- a/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/CompatDecoderFactory.java
+++ b/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/CompatDecoderFactory.java
@@ -14,10 +14,19 @@ public class CompatDecoderFactory<T> implements DecoderFactory<T> {
   private Class<? extends T> clazz;
   private Bitmap.Config bitmapConfig;
 
+  /**
+   * Construct a factory for the given class. This must have a default constructor.
+   * @param clazz a class that implements {@link ImageDecoder} or {@link ImageRegionDecoder}.
+   */
   public CompatDecoderFactory(@NonNull Class<? extends T> clazz) {
     this(clazz, null);
   }
 
+  /**
+   * Construct a factory for the given class. This must have a constructor that accepts a {@link Bitmap.Config} instance.
+   * @param clazz a class that implements {@link ImageDecoder} or {@link ImageRegionDecoder}.
+   * @param bitmapConfig bitmap configuration to be used when loading images.
+   */
   public CompatDecoderFactory(@NonNull Class<? extends T> clazz, Bitmap.Config bitmapConfig) {
     this.clazz = clazz;
     this.bitmapConfig = bitmapConfig;
diff --git a/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.java b/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.java
index f15d283..8bb5c16 100644
--- a/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.java
+++ b/library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/DecoderFactory.java
@@ -10,6 +10,10 @@ public interface DecoderFactory<T> {
   /**
    * Produce a new instance of a decoder with type {@link T}.
    * @return a new instance of your decoder.
+   * @throws IllegalAccessException if the factory class cannot be instantiated.
+   * @throws InstantiationException if the factory class cannot be instantiated.
+   * @throws NoSuchMethodException if the factory class cannot be instantiated.
+   * @throws InvocationTargetException if the factory class cannot be instantiated.
    */
   T make() throws IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException;
 }