From dc309f26f8a092e5b4be429b4980f4b1e7474e2d Mon Sep 17 00:00:00 2001 From: Aurimas Liutikas Date: Mon, 4 Jun 2018 15:35:31 -0700 Subject: [PATCH] Fix broken links in @see tags in framework docs. doclava was accidentally suppressing all these broken links in @see tags. This CL fixes issues so we can start enfocing checks for broken @see links. Test: make docs Bug: 80589960 Change-Id: I9c56841d9af111cb72e9a309bbe1bdcd31c80553 --- .../camera2/CameraCaptureSession.java | 4 ++-- .../hardware/camera2/CaptureFailure.java | 4 ++-- .../hardware/camera2/CaptureResult.java | 4 ++-- .../hardware/camera2/TotalCaptureResult.java | 2 +- .../android/hardware/camera2/params/Face.java | 1 - .../camera2/params/LensShadingMap.java | 22 +++++++++++++------ .../params/StreamConfigurationMap.java | 12 +++++----- .../hardware/camera2/params/TonemapCurve.java | 6 ----- .../test/suitebuilder/annotation/Smoke.java | 2 -- 9 files changed, 28 insertions(+), 29 deletions(-) diff --git a/core/java/android/hardware/camera2/CameraCaptureSession.java b/core/java/android/hardware/camera2/CameraCaptureSession.java index eafe5938d38bc..bc7ab476b01b0 100644 --- a/core/java/android/hardware/camera2/CameraCaptureSession.java +++ b/core/java/android/hardware/camera2/CameraCaptureSession.java @@ -23,8 +23,8 @@ import android.hardware.camera2.params.OutputConfiguration; import android.os.Handler; import android.view.Surface; -import java.util.concurrent.Executor; import java.util.List; +import java.util.concurrent.Executor; /** * A configured capture session for a {@link CameraDevice}, used for capturing images from the @@ -745,7 +745,7 @@ public abstract class CameraCaptureSession implements AutoCloseable { * * @see #setRepeatingRequest * @see #setRepeatingBurst - * @see StateCallback#onIdle + * @see StateCallback#onReady */ public abstract void stopRepeating() throws CameraAccessException; diff --git a/core/java/android/hardware/camera2/CaptureFailure.java b/core/java/android/hardware/camera2/CaptureFailure.java index fbe0839ddc376..cd2bc5f943e7b 100644 --- a/core/java/android/hardware/camera2/CaptureFailure.java +++ b/core/java/android/hardware/camera2/CaptureFailure.java @@ -15,8 +15,8 @@ */ package android.hardware.camera2; -import android.annotation.NonNull; import android.annotation.IntDef; +import android.annotation.NonNull; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -150,7 +150,7 @@ public class CaptureFailure { * * @return int The ID for the sequence of requests that this capture failure is the result of * - * @see CameraDevice.CaptureCallback#onCaptureSequenceCompleted + * @see CameraCaptureSession.CaptureCallback#onCaptureSequenceCompleted */ public int getSequenceId() { return mSequenceId; diff --git a/core/java/android/hardware/camera2/CaptureResult.java b/core/java/android/hardware/camera2/CaptureResult.java index 6439338428ee3..361d83dacb7a3 100644 --- a/core/java/android/hardware/camera2/CaptureResult.java +++ b/core/java/android/hardware/camera2/CaptureResult.java @@ -370,8 +370,8 @@ public class CaptureResult extends CameraMetadata> { * * @return int The ID for the sequence of requests that this capture result is a part of * - * @see CameraDevice.CaptureCallback#onCaptureSequenceCompleted - * @see CameraDevice.CaptureCallback#onCaptureSequenceAborted + * @see CameraCaptureSession.CaptureCallback#onCaptureSequenceCompleted + * @see CameraCaptureSession.CaptureCallback#onCaptureSequenceAborted */ public int getSequenceId() { return mSequenceId; diff --git a/core/java/android/hardware/camera2/TotalCaptureResult.java b/core/java/android/hardware/camera2/TotalCaptureResult.java index 4e20cb8d129ea..7cc2623a29baa 100644 --- a/core/java/android/hardware/camera2/TotalCaptureResult.java +++ b/core/java/android/hardware/camera2/TotalCaptureResult.java @@ -55,7 +55,7 @@ import java.util.Map; * *

{@link TotalCaptureResult} objects are immutable.

* - * @see CameraDevice.CaptureCallback#onCaptureCompleted + * @see CameraCaptureSession.CaptureCallback#onCaptureCompleted */ public final class TotalCaptureResult extends CaptureResult { diff --git a/core/java/android/hardware/camera2/params/Face.java b/core/java/android/hardware/camera2/params/Face.java index 2cd83a3254a3c..e94f11d8a0566 100644 --- a/core/java/android/hardware/camera2/params/Face.java +++ b/core/java/android/hardware/camera2/params/Face.java @@ -31,7 +31,6 @@ public final class Face { /** * The ID is {@code -1} when the optional set of fields is unsupported. * - * @see Face#Face(Rect, int) * @see #getId() */ public static final int ID_UNSUPPORTED = -1; diff --git a/core/java/android/hardware/camera2/params/LensShadingMap.java b/core/java/android/hardware/camera2/params/LensShadingMap.java index d6b84f2c98214..9eb276f29c81c 100644 --- a/core/java/android/hardware/camera2/params/LensShadingMap.java +++ b/core/java/android/hardware/camera2/params/LensShadingMap.java @@ -16,8 +16,16 @@ package android.hardware.camera2.params; -import static com.android.internal.util.Preconditions.*; -import static android.hardware.camera2.params.RggbChannelVector.*; +import static android.hardware.camera2.params.RggbChannelVector.BLUE; +import static android.hardware.camera2.params.RggbChannelVector.COUNT; +import static android.hardware.camera2.params.RggbChannelVector.GREEN_EVEN; +import static android.hardware.camera2.params.RggbChannelVector.GREEN_ODD; +import static android.hardware.camera2.params.RggbChannelVector.RED; + +import static com.android.internal.util.Preconditions.checkArgumentNonnegative; +import static com.android.internal.util.Preconditions.checkArgumentPositive; +import static com.android.internal.util.Preconditions.checkArrayElementsInRange; +import static com.android.internal.util.Preconditions.checkNotNull; import android.hardware.camera2.CaptureResult; import android.hardware.camera2.utils.HashCodeHelpers; @@ -117,10 +125,10 @@ public final class LensShadingMap { * * @throws IllegalArgumentException if any of the parameters was out of range * - * @see #RED - * @see #GREEN_EVEN - * @see #GREEN_ODD - * @see #BLUE + * @see RggbChannelVector#RED + * @see RggbChannelVector#GREEN_EVEN + * @see RggbChannelVector#GREEN_ODD + * @see RggbChannelVector#BLUE * @see #getRowCount * @see #getColumnCount */ @@ -191,7 +199,7 @@ public final class LensShadingMap { * If there's not enough room to write the elements at the specified destination and * offset. * - * @see CaptureResult#STATISTICS_LENS_SHADING_MAP + * @see CaptureResult#STATISTICS_LENS_SHADING_CORRECTION_MAP */ public void copyGainFactors(final float[] destination, final int offset) { checkArgumentNonnegative(offset, "offset must not be negative"); diff --git a/core/java/android/hardware/camera2/params/StreamConfigurationMap.java b/core/java/android/hardware/camera2/params/StreamConfigurationMap.java index 00e047db98c0f..c56b68523daf2 100644 --- a/core/java/android/hardware/camera2/params/StreamConfigurationMap.java +++ b/core/java/android/hardware/camera2/params/StreamConfigurationMap.java @@ -16,28 +16,28 @@ package android.hardware.camera2.params; +import static com.android.internal.util.Preconditions.checkArrayElementsNotNull; +import static com.android.internal.util.Preconditions.checkNotNull; + import android.graphics.ImageFormat; import android.graphics.PixelFormat; import android.hardware.camera2.CameraCharacteristics; import android.hardware.camera2.CameraDevice; import android.hardware.camera2.CameraMetadata; import android.hardware.camera2.CaptureRequest; +import android.hardware.camera2.legacy.LegacyCameraDevice; import android.hardware.camera2.utils.HashCodeHelpers; import android.hardware.camera2.utils.SurfaceUtils; -import android.hardware.camera2.legacy.LegacyCameraDevice; -import android.hardware.camera2.legacy.LegacyMetadataMapper; -import android.view.Surface; import android.util.Range; import android.util.Size; import android.util.SparseIntArray; +import android.view.Surface; import java.util.Arrays; import java.util.HashMap; import java.util.Objects; import java.util.Set; -import static com.android.internal.util.Preconditions.*; - /** * Immutable class to store the available stream * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP configurations} to set up @@ -609,7 +609,7 @@ public final class StreamConfigurationMap { * @see #getHighSpeedVideoSizesFor * @see CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO * @see CameraDevice#createConstrainedHighSpeedCaptureSession - * @see CameraDevice#createHighSpeedRequestList + * @see android.hardware.camera2.CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList */ @SuppressWarnings("unchecked") public Range[] getHighSpeedVideoFpsRanges() { diff --git a/core/java/android/hardware/camera2/params/TonemapCurve.java b/core/java/android/hardware/camera2/params/TonemapCurve.java index 2d7bbaa21c54a..71e68a5271c23 100644 --- a/core/java/android/hardware/camera2/params/TonemapCurve.java +++ b/core/java/android/hardware/camera2/params/TonemapCurve.java @@ -40,9 +40,6 @@ import java.util.Arrays; *

The coordinate system for each point is within the inclusive range * [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}].

* - * @see CaptureRequest#TONEMAP_CURVE_BLUE - * @see CaptureRequest#TONEMAP_CURVE_GREEN - * @see CaptureRequest#TONEMAP_CURVE_RED * @see CameraMetadata#TONEMAP_MODE_CONTRAST_CURVE * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS */ @@ -223,9 +220,6 @@ public final class TonemapCurve { * If there's not enough room to write the elements at the specified destination and * offset. * - * @see CaptureRequest#TONEMAP_CURVE_BLUE - * @see CaptureRequest#TONEMAP_CURVE_RED - * @see CaptureRequest#TONEMAP_CURVE_GREEN * @see #LEVEL_BLACK * @see #LEVEL_WHITE */ diff --git a/test-base/src/android/test/suitebuilder/annotation/Smoke.java b/test-base/src/android/test/suitebuilder/annotation/Smoke.java index aac293796be13..34563717894fc 100644 --- a/test-base/src/android/test/suitebuilder/annotation/Smoke.java +++ b/test-base/src/android/test/suitebuilder/annotation/Smoke.java @@ -26,8 +26,6 @@ import java.lang.annotation.Target; * The android.test.suitebuilder.SmokeTestSuiteBuilder * will run all tests with this annotation. * - * @see android.test.suitebuilder.SmokeTestSuiteBuilder - * * @deprecated New tests should be written using the * Android Testing Support Library. */