From 78146ecb24871302a4c4dc0a7341044a06d29ee8 Mon Sep 17 00:00:00 2001
From: Zhijun He <zhijunhe@google.com>
Date: Tue, 14 Jan 2014 18:12:13 -0800
Subject: [PATCH] Camera2: Update AF mode related javadoc specs

Change-Id: If7a0de76f660ade25d9fdb92458fbe7e9752d0dd
---
 .../android/hardware/camera2/CameraCharacteristics.java     | 13 ++++++++++++-
 core/java/android/hardware/camera2/CaptureRequest.java      | 11 +++++------
 core/java/android/hardware/camera2/CaptureResult.java       |  7 +++----
 3 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/core/java/android/hardware/camera2/CameraCharacteristics.java b/core/java/android/hardware/camera2/CameraCharacteristics.java
index cdbf95a31aab..d5476fc9392d 100644
--- a/core/java/android/hardware/camera2/CameraCharacteristics.java
+++ b/core/java/android/hardware/camera2/CameraCharacteristics.java
@@ -181,7 +181,18 @@ public final class CameraCharacteristics extends CameraMetadata {
 
     /**
      * <p>List of AF modes that can be
-     * selected</p>
+     * selected with {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p>
+     *
+     * @see CaptureRequest#CONTROL_AF_MODE
+     * <p>Not all the auto-focus modes may be supported by a
+     * given camera device. This entry lists the valid modes for
+     * {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} for this camera device.</p>
+     * <p>All camera devices will support OFF mode, and all camera devices with
+     * adjustable focuser units (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} &gt; 0</code>)
+     * will support AUTO mode.</p>
+     *
+     * @see CaptureRequest#CONTROL_AF_MODE
+     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
      */
     public static final Key<byte[]> CONTROL_AF_AVAILABLE_MODES =
             new Key<byte[]>("android.control.afAvailableModes", byte[].class);
diff --git a/core/java/android/hardware/camera2/CaptureRequest.java b/core/java/android/hardware/camera2/CaptureRequest.java
index 78c5db96ffa5..d6420766428f 100644
--- a/core/java/android/hardware/camera2/CaptureRequest.java
+++ b/core/java/android/hardware/camera2/CaptureRequest.java
@@ -399,8 +399,8 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
      * issues. The {@link CaptureResult#STATISTICS_SCENE_FLICKER android.statistics.sceneFlicker} key can assist
      * the application in this.</p>
      *
-     * @see CaptureResult#STATISTICS_SCENE_FLICKER
      * @see CaptureRequest#CONTROL_AE_MODE
+     * @see CaptureResult#STATISTICS_SCENE_FLICKER
      * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES
      * @see CaptureRequest#CONTROL_MODE
      * @see #CONTROL_AE_ANTIBANDING_MODE_OFF
@@ -523,12 +523,11 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
      * <p>Whether AF is currently enabled, and what
      * mode it is set to</p>
      * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p>
-     * <p>If lens is controlled by HAL auto-focus algorithm, the HAL should
-     * report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} in
-     * result metadata.</p>
+     * <p>If the lens is controlled by the camera device auto-focus algorithm,
+     * the camera device will report the current AF status in android.control.afState
+     * in result metadata.</p>
      *
      * @see CaptureRequest#CONTROL_MODE
-     * @see CaptureResult#CONTROL_AF_STATE
      * @see #CONTROL_AF_MODE_OFF
      * @see #CONTROL_AF_MODE_AUTO
      * @see #CONTROL_AF_MODE_MACRO
@@ -828,8 +827,8 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
      * back to the user in the corresponding result.</p>
      *
      * @see CaptureRequest#CONTROL_AE_MODE
-     * @see CaptureRequest#SENSOR_SENSITIVITY
      * @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
+     * @see CaptureRequest#SENSOR_SENSITIVITY
      * @see CaptureRequest#SENSOR_EXPOSURE_TIME
      */
     public static final Key<Float> LENS_APERTURE =
diff --git a/core/java/android/hardware/camera2/CaptureResult.java b/core/java/android/hardware/camera2/CaptureResult.java
index 0af7d0fe2321..8e5af6d31c22 100644
--- a/core/java/android/hardware/camera2/CaptureResult.java
+++ b/core/java/android/hardware/camera2/CaptureResult.java
@@ -253,12 +253,11 @@ public final class CaptureResult extends CameraMetadata {
      * <p>Whether AF is currently enabled, and what
      * mode it is set to</p>
      * <p>Only effective if {@link CaptureRequest#CONTROL_MODE android.control.mode} = AUTO.</p>
-     * <p>If lens is controlled by HAL auto-focus algorithm, the HAL should
-     * report the current AF status in {@link CaptureResult#CONTROL_AF_STATE android.control.afState} in
-     * result metadata.</p>
+     * <p>If the lens is controlled by the camera device auto-focus algorithm,
+     * the camera device will report the current AF status in android.control.afState
+     * in result metadata.</p>
      *
      * @see CaptureRequest#CONTROL_MODE
-     * @see CaptureResult#CONTROL_AF_STATE
      * @see #CONTROL_AF_MODE_OFF
      * @see #CONTROL_AF_MODE_AUTO
      * @see #CONTROL_AF_MODE_MACRO
-- 
2.11.0