From b58d77f052e29fe1baccf01857a2f8ec257f8f9d Mon Sep 17 00:00:00 2001
From: Mattia Iavarone <mat.iavarone@gmail.com>
Date: Sun, 6 Aug 2017 18:19:07 +0200
Subject: [PATCH] CameraOptions docs

---
 .../com/flurgle/camerakit/CameraOptions.java  | 60 ++++++++++++++++++-
 1 file changed, 57 insertions(+), 3 deletions(-)

diff --git a/camerakit/src/main/base/com/flurgle/camerakit/CameraOptions.java b/camerakit/src/main/base/com/flurgle/camerakit/CameraOptions.java
index 34cc5e5b..827d04a8 100644
--- a/camerakit/src/main/base/com/flurgle/camerakit/CameraOptions.java
+++ b/camerakit/src/main/base/com/flurgle/camerakit/CameraOptions.java
@@ -22,6 +22,8 @@ public class CameraOptions {
     private boolean zoomSupported;
     private boolean videoSnapshotSupported;
 
+
+    // Camera1 constructor.
     CameraOptions(Camera.Parameters params) {
         List<String> strings;
         Mapper mapper = new Mapper.Mapper1();
@@ -57,34 +59,86 @@ public class CameraOptions {
 
         zoomSupported = params.isZoomSupported();
         videoSnapshotSupported = params.isVideoSnapshotSupported();
-
-
-
     }
 
+
+    // Camera2 constructor.
     @TargetApi(21)
     CameraOptions(CameraCharacteristics params) {}
 
+
+    /**
+     * List of supported facing values.
+     *
+     * @see CameraConstants#FACING_BACK
+     * @see CameraConstants#FACING_FRONT
+     * @return a list of supported values.
+     */
     public List<Integer> getSupportedFacing() {
         return supportedFacing;
     }
 
+
+    /**
+     * List of supported flash values.
+     *
+     * @see CameraConstants#FLASH_AUTO
+     * @see CameraConstants#FLASH_OFF
+     * @see CameraConstants#FLASH_ON
+     * @see CameraConstants#FLASH_TORCH
+     * @return a list of supported values.
+     */
     public List<Integer> getSupportedFlash() {
         return supportedFlash;
     }
 
+
+    /**
+     * List of supported white balance values.
+     *
+     * @see CameraConstants#WHITE_BALANCE_AUTO
+     * @see CameraConstants#WHITE_BALANCE_CLOUDY
+     * @see CameraConstants#WHITE_BALANCE_DAYLIGHT
+     * @see CameraConstants#WHITE_BALANCE_FLUORESCENT
+     * @see CameraConstants#WHITE_BALANCE_INCANDESCENT
+     * @return a list of supported values.
+     */
     public List<Integer> getSupportedWhiteBalance() {
         return supportedWhiteBalance;
     }
 
+
+    /**
+     * List of supported focus values.
+     *
+     * @see CameraConstants#FOCUS_FIXED
+     * @see CameraConstants#FOCUS_CONTINUOUS
+     * @see CameraConstants#FOCUS_TAP
+     * @see CameraConstants#FOCUS_TAP_WITH_MARKER
+     * @return a list of supported values.
+     */
     public List<Integer> getSupportedFocus() {
         return supportedFocus;
     }
 
+
+    /**
+     * Whether zoom is supported. If this is false, pinch-to-zoom
+     * will not work and {@link CameraView#setZoom(float)} will have no effect.
+     *
+     * @return whether zoom is supported.
+     */
     public boolean isZoomSupported() {
         return zoomSupported;
     }
 
+
+    /**
+     * Whether video snapshots are supported. If this is false, taking pictures
+     * while recording a video will have no effect.
+     *
+     * @return whether video snapshot is supported.
+     */
     public boolean isVideoSnapshotSupported() {
         return videoSnapshotSupported;
     }