summaryrefslogtreecommitdiffstats
path: root/core/java/android/hardware
diff options
context:
space:
mode:
authorJoe Fernandez <joefernandez@google.com>2011-10-04 16:56:47 -0700
committerJoe Fernandez <joefernandez@google.com>2011-10-04 16:56:47 -0700
commit464cb21e2aaa448072449b82156f18bd64c0e613 (patch)
tree99d7af8b05a03f0c4f64200a934d893b259fe1c2 /core/java/android/hardware
parenta1aebdf787443413ba870fc9203639405a5ff7bf (diff)
downloadframeworks_base-464cb21e2aaa448072449b82156f18bd64c0e613.zip
frameworks_base-464cb21e2aaa448072449b82156f18bd64c0e613.tar.gz
frameworks_base-464cb21e2aaa448072449b82156f18bd64c0e613.tar.bz2
docs: Camera class JavaDoc FixIts for ICS
Change-Id: I03d96247d149baf82c53b33aa7737fca11906ce6
Diffstat (limited to 'core/java/android/hardware')
-rw-r--r--core/java/android/hardware/Camera.java24
1 files changed, 14 insertions, 10 deletions
diff --git a/core/java/android/hardware/Camera.java b/core/java/android/hardware/Camera.java
index e40de26..c3a14ca 100644
--- a/core/java/android/hardware/Camera.java
+++ b/core/java/android/hardware/Camera.java
@@ -201,7 +201,7 @@ public class Camera {
public static final int CAMERA_FACING_FRONT = 1;
/**
- * The direction that the camera faces to. It should be
+ * The direction that the camera faces. It should be
* CAMERA_FACING_BACK or CAMERA_FACING_FRONT.
*/
public int facing;
@@ -1055,9 +1055,9 @@ public class Camera {
/**
* Notify the listener of the detected faces in the preview frame.
*
- * @param faces the detected faces. The list is sorted by the score.
- * The highest score is the first element.
- * @param camera the Camera service object
+ * @param faces The detected faces in a list sorted by the confidence score.
+ * The highest scored face is the first element.
+ * @param camera The {@link Camera} service object
*/
void onFaceDetection(Face[] faces, Camera camera);
}
@@ -1105,7 +1105,7 @@ public class Camera {
/**
* Stops the face detection.
*
- * @see #startFaceDetection(int)
+ * @see #startFaceDetection()
*/
public final void stopFaceDetection() {
_stopFaceDetection();
@@ -1116,8 +1116,12 @@ public class Camera {
private native final void _stopFaceDetection();
/**
- * The information of a face from camera face detection.
+ * Information about a face identified through camera face detection.
+ *
+ * <p>When face detection is used with a camera, the {@link FaceDetectionListener} returns a
+ * list of face objects for use in focusing and metering.</p>
*
+ * @see FaceDetectionListener
*/
public static class Face {
/**
@@ -1138,15 +1142,15 @@ public class Camera {
* the sensor sees. The direction is not affected by the rotation or
* mirroring of {@link #setDisplayOrientation(int)}.</p>
*
- * @see #startFaceDetection(int)
+ * @see #startFaceDetection()
*/
public Rect rect;
/**
- * The confidence level of the face. The range is 1 to 100. 100 is the
+ * The confidence level for the detection of the face. The range is 1 to 100. 100 is the
* highest confidence.
*
- * @see #startFaceDetection(int)
+ * @see #startFaceDetection()
*/
public int score;
@@ -3144,7 +3148,7 @@ public class Camera {
* supported.
*
* @return the maximum number of detected face supported by the camera.
- * @see #startFaceDetection(int)
+ * @see #startFaceDetection()
*/
public int getMaxNumDetectedFaces() {
return getInt(KEY_MAX_NUM_DETECTED_FACES_HW, 0);