Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 16ffbc65 authored by Eino-Ville Talvala's avatar Eino-Ville Talvala
Browse files

Camera: Update docs for new auto-generation features 

Annotate @IntDef with prefixes where possible.

Test: Look at doc output
Bug: 37635513
Change-Id: Iff3a9ecf83f348b56b3186e4dfe94a1e7697cfaf
parent 094996a2

core/java/android/hardware/camera2/CameraDevice.java

+7 −9
Original line number Diff line number Diff line
@@ -135,7 +135,7 @@ public abstract class CameraDevice implements AutoCloseable { 


     /** @hide */

     @Retention(RetentionPolicy.SOURCE)

     @IntDef(

     @IntDef(prefix = {"TEMPLATE_"}, value =

         {TEMPLATE_PREVIEW,

          TEMPLATE_STILL_CAPTURE,

          TEMPLATE_RECORD,
@@ -757,7 +757,7 @@ public abstract class CameraDevice implements AutoCloseable { 


    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef(

    @IntDef(prefix = {"SESSION_OPERATION_MODE"}, value =

            {SESSION_OPERATION_MODE_NORMAL,

             SESSION_OPERATION_MODE_CONSTRAINED_HIGH_SPEED,

             SESSION_OPERATION_MODE_VENDOR_START})
@@ -808,10 +808,9 @@ public abstract class CameraDevice implements AutoCloseable { 
     * create a builder specific for that device and template and override the

     * settings as desired, instead.</p>

     *

     * @param templateType An enumeration selecting the use case for this

     * request; one of the CameraDevice.TEMPLATE_ values. Not all template

     * types are supported on every device. See the documentation for each

     * template type for details.

     * @param templateType An enumeration selecting the use case for this request. Not all template

     * types are supported on every device. See the documentation for each template type for

     * details.

     * @return a builder for a capture request, initialized with default

     * settings for that template, and no output streams

     *
@@ -969,7 +968,7 @@ public abstract class CameraDevice implements AutoCloseable { 


        /** @hide */

        @Retention(RetentionPolicy.SOURCE)

        @IntDef(

        @IntDef(prefix = {"ERROR_"}, value =

            {ERROR_CAMERA_IN_USE,

             ERROR_MAX_CAMERAS_IN_USE,

             ERROR_CAMERA_DISABLED,
@@ -1052,8 +1051,7 @@ public abstract class CameraDevice implements AutoCloseable { 
         * this happens. Further attempts at recovery are error-code specific.</p>

         *

         * @param camera The device reporting the error

         * @param error The error code, one of the

         *     {@code StateCallback.ERROR_*} values.

         * @param error The error code.

         *

         * @see #ERROR_CAMERA_IN_USE

         * @see #ERROR_MAX_CAMERAS_IN_USE

core/java/android/hardware/camera2/CaptureFailure.java

+2 −2
Original line number Diff line number Diff line
@@ -51,7 +51,7 @@ public class CaptureFailure { 


     /** @hide */

     @Retention(RetentionPolicy.SOURCE)

     @IntDef(

     @IntDef(prefix = {"REASON_"}, value =

         {REASON_ERROR,

          REASON_FLUSHED })

     public @interface FailureReason {};
@@ -119,7 +119,7 @@ public class CaptureFailure { 
     * Determine why the request was dropped, whether due to an error or to a user

     * action.

     *

     * @return int One of {@code REASON_*} integer constants.

     * @return int The reason code.

     *

     * @see #REASON_ERROR

     * @see #REASON_FLUSHED