Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

camera2: Fix @see being emitted into middle of javadoc (+more)

Browse Source 
Other minor fixes:
- javadoc optional/FULL correctly emitted for properties lacking details
- javadoc details being incorrectly dedented before being rendered by
  markdown, causing spurious <code> blocks to be emitted

Bug: 12552669
Change-Id: I4c6615ec47810757b8348995db2b199222a3a77e
This commit is contained in:
Igor Murashkin
2014-01-15 12:27:41 -08:00
parent 70216e599e
commit 3242f4fb19
4 changed files with 37 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
core/java/android/hardware/camera2/CameraCharacteristics.java
View File

@@ -182,8 +182,6 @@ public final class CameraCharacteristics extends CameraMetadata {
/**
* <p>List of AF modes that can be
* 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>
@@ -221,8 +219,6 @@ public final class CameraCharacteristics extends CameraMetadata {
/**
* <p>The set of auto-white-balance modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode})
* that are supported by this camera device.</p>
*
* @see CaptureRequest#CONTROL_AWB_MODE
* <p>Not all the auto-white-balance modes may be supported by a
* given camera device. This entry lists the valid modes for
* {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} for this camera device.</p>
@@ -231,9 +227,9 @@ public final class CameraCharacteristics extends CameraMetadata {
* which enables application control of white balance, by using
* {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}({@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} must be set to TRANSFORM_MATRIX).</p>
*
* @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#CONTROL_AWB_MODE
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
* @see CaptureRequest#COLOR_CORRECTION_GAINS
*/
public static final Key<byte[]> CONTROL_AWB_AVAILABLE_MODES =
@@ -359,7 +355,7 @@ public final class CameraCharacteristics extends CameraMetadata {
* future versions of camera service. This quirk will stop
* working at that point; DO NOT USE without careful
* consideration of future support.</p>
* <p><b>Optional</b> - This value may be null on some devices.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* @hide
*/
public static final Key<Byte> QUIRKS_USE_PARTIAL_RESULT =
@@ -482,6 +478,12 @@ public final class CameraCharacteristics extends CameraMetadata {
/**
* <p>Gain factor from electrons to raw units when
* ISO=100</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
*/
public static final Key<Rational> SENSOR_BASE_GAIN_FACTOR =
new Key<Rational>("android.sensor.baseGainFactor", Rational.class);
@@ -493,7 +495,7 @@ public final class CameraCharacteristics extends CameraMetadata {
* equal to this, all applied gain must be analog. For
* values above this, it can be a mix of analog and
* digital</p>
* <p><b>Optional</b> - This value may be null on some devices.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>

8
core/java/android/hardware/camera2/CameraMetadata.java
View File

@@ -318,8 +318,8 @@ public abstract class CameraMetadata {
* device, along with android.flash.* fields, if there's
* a flash unit for this camera device.</p>
*
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CaptureRequest#CONTROL_AE_MODE
*/
@@ -334,8 +334,8 @@ public abstract class CameraMetadata {
* application has control over the various
* android.flash.* fields.</p>
*
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CaptureRequest#CONTROL_AE_MODE
*/
@@ -351,8 +351,8 @@ public abstract class CameraMetadata {
* {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
* STILL_CAPTURE</p>
*
* @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
* @see CaptureRequest#CONTROL_CAPTURE_INTENT
* @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
* @see CaptureRequest#CONTROL_AE_MODE
*/
public static final int CONTROL_AE_MODE_ON_AUTO_FLASH = 2;
@@ -367,8 +367,8 @@ public abstract class CameraMetadata {
* {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
* STILL_CAPTURE</p>
*
* @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
* @see CaptureRequest#CONTROL_CAPTURE_INTENT
* @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
* @see CaptureRequest#CONTROL_AE_MODE
*/
public static final int CONTROL_AE_MODE_ON_ALWAYS_FLASH = 3;

15
core/java/android/hardware/camera2/CaptureRequest.java
View File

@@ -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 CaptureRequest#CONTROL_MODE
* @see CameraCharacteristics#CONTROL_AE_AVAILABLE_ANTIBANDING_MODES
* @see CaptureRequest#CONTROL_MODE
* @see CaptureResult#STATISTICS_SCENE_FLICKER
* @see CaptureRequest#CONTROL_AE_MODE
* @see #CONTROL_AE_ANTIBANDING_MODE_OFF
@@ -453,12 +453,12 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
* fields for a given capture will be available in its
* CaptureResult.</p>
*
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CaptureRequest#FLASH_MODE
* @see CameraCharacteristics#FLASH_INFO_AVAILABLE
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see #CONTROL_AE_MODE_OFF
* @see #CONTROL_AE_MODE_ON
* @see #CONTROL_AE_MODE_ON_AUTO_FLASH
@@ -605,9 +605,9 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
* routine is disabled. The camera device uses each particular illumination
* target for white balance adjustment.</p>
*
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#COLOR_CORRECTION_GAINS
* @see #CONTROL_AWB_MODE_OFF
* @see #CONTROL_AWB_MODE_AUTO
@@ -839,9 +839,9 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
* auto-exposure algorithm, the overridden values are then provided
* back to the user in the corresponding result.</p>
*
* @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
* @see CaptureRequest#CONTROL_AE_MODE
*/
public static final Key<Float> LENS_APERTURE =
@@ -1009,8 +1009,8 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
* channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p>
* <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
*
* @see CaptureRequest#TONEMAP_CURVE_RED
* @see CaptureRequest#TONEMAP_MODE
* @see CaptureRequest#TONEMAP_CURVE_RED
*/
public static final Key<float[]> TONEMAP_CURVE_BLUE =
new Key<float[]>("android.tonemap.curveBlue", float[].class);
@@ -1022,8 +1022,8 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
* channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p>
* <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
*
* @see CaptureRequest#TONEMAP_CURVE_RED
* @see CaptureRequest#TONEMAP_MODE
* @see CaptureRequest#TONEMAP_CURVE_RED
*/
public static final Key<float[]> TONEMAP_CURVE_GREEN =
new Key<float[]>("android.tonemap.curveGreen", float[].class);
@@ -1050,6 +1050,7 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable {
new Key<float[]>("android.tonemap.curveRed", float[].class);
/**
*
* @see #TONEMAP_MODE_CONTRAST_CURVE
* @see #TONEMAP_MODE_FAST
* @see #TONEMAP_MODE_HIGH_QUALITY

23
core/java/android/hardware/camera2/CaptureResult.java
View File

@@ -195,12 +195,12 @@ public final class CaptureResult extends CameraMetadata {
* fields for a given capture will be available in its
* CaptureResult.</p>
*
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CaptureRequest#FLASH_MODE
* @see CameraCharacteristics#FLASH_INFO_AVAILABLE
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_FRAME_DURATION
* @see #CONTROL_AE_MODE_OFF
* @see #CONTROL_AE_MODE_ON
* @see #CONTROL_AE_MODE_ON_AUTO_FLASH
@@ -336,9 +336,9 @@ public final class CaptureResult extends CameraMetadata {
* routine is disabled. The camera device uses each particular illumination
* target for white balance adjustment.</p>
*
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureRequest#CONTROL_MODE
* @see CaptureRequest#COLOR_CORRECTION_GAINS
* @see #CONTROL_AWB_MODE_OFF
* @see #CONTROL_AWB_MODE_AUTO
@@ -521,9 +521,9 @@ public final class CaptureResult extends CameraMetadata {
* auto-exposure algorithm, the overridden values are then provided
* back to the user in the corresponding result.</p>
*
* @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
* @see CaptureRequest#SENSOR_EXPOSURE_TIME
* @see CaptureRequest#SENSOR_SENSITIVITY
* @see CameraCharacteristics#LENS_INFO_AVAILABLE_APERTURES
* @see CaptureRequest#CONTROL_AE_MODE
*/
public static final Key<Float> LENS_APERTURE =
@@ -611,7 +611,7 @@ public final class CaptureResult extends CameraMetadata {
* in any order relative to other frames, but all PARTIAL buffers for a given
* capture must arrive before the FINAL buffer for that capture. This entry may
* only be used by the HAL if quirks.usePartialResult is set to 1.</p>
* <p><b>Optional</b> - This value may be null on some devices.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* @hide
*/
public static final Key<Boolean> QUIRKS_PARTIAL_RESULT =
@@ -713,6 +713,12 @@ public final class CaptureResult extends CameraMetadata {
* exposure began for this frame.</p>
* <p>The thermal diode being queried should be inside the sensor PCB, or
* somewhere close to it.</p>
* <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
* <p><b>Full capability</b> -
* Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
* {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
*
* @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
*/
public static final Key<Float> SENSOR_TEMPERATURE =
new Key<Float>("android.sensor.temperature", float.class);
@@ -812,8 +818,8 @@ public final class CaptureResult extends CameraMetadata {
* image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
* <p><img alt="Image of a uniform white wall (inverse shading map)" src="../../../../images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png" /></p>
*
* @see CaptureResult#STATISTICS_LENS_SHADING_MAP
* @see CaptureRequest#COLOR_CORRECTION_MODE
* @see CaptureResult#STATISTICS_LENS_SHADING_MAP
* @see CameraCharacteristics#LENS_INFO_SHADING_MAP_SIZE
*/
public static final Key<float[]> STATISTICS_LENS_SHADING_MAP =
@@ -875,8 +881,8 @@ public final class CaptureResult extends CameraMetadata {
* channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p>
* <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
*
* @see CaptureRequest#TONEMAP_CURVE_RED
* @see CaptureRequest#TONEMAP_MODE
* @see CaptureRequest#TONEMAP_CURVE_RED
*/
public static final Key<float[]> TONEMAP_CURVE_BLUE =
new Key<float[]>("android.tonemap.curveBlue", float[].class);
@@ -888,8 +894,8 @@ public final class CaptureResult extends CameraMetadata {
* channel, to use when {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} is CONTRAST_CURVE.</p>
* <p>See {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed} for more details.</p>
*
* @see CaptureRequest#TONEMAP_CURVE_RED
* @see CaptureRequest#TONEMAP_MODE
* @see CaptureRequest#TONEMAP_CURVE_RED
*/
public static final Key<float[]> TONEMAP_CURVE_GREEN =
new Key<float[]>("android.tonemap.curveGreen", float[].class);
@@ -916,6 +922,7 @@ public final class CaptureResult extends CameraMetadata {
new Key<float[]>("android.tonemap.curveRed", float[].class);
/**
*
* @see #TONEMAP_MODE_CONTRAST_CURVE
* @see #TONEMAP_MODE_FAST
* @see #TONEMAP_MODE_HIGH_QUALITY