Fix Java API doc errors in TFLite Java Library and Support Library

PiperOrigin-RevId: 374126621

Author: lu-wang-g

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/audio/TensorAudio.java

@@ -37,8 +37,9 @@
  * aggregated audio samples via `getTensorBuffer` method.
  *
  * <p>Note that this class can only handle input audio in Float (in {@link
- * AudioFormat#ENCODING_PCM_16BIT}) or Short (in {@link AudioFormat#ENCODING_PCM_FLOAT}). Internally
- * it converts and stores all the audio samples in PCM Float encoding.
+ * android.media.AudioFormat#ENCODING_PCM_16BIT}) or Short (in {@link
+ * android.media.AudioFormat#ENCODING_PCM_FLOAT}). Internally it converts and stores all the audio
+ * samples in PCM Float encoding.
  *
  * <p>Typical usage in Kotlin
  *
@@ -48,7 +49,7 @@
  *   interpreter.run(tensor.getTensorBuffer(), outputBuffer);
  * </pre>
  *
- * <p>Another sample usage with {@link AudioRecord}
+ * <p>Another sample usage with {@link android.media.AudioRecord}
  *
  * <pre>
  *   val tensor = TensorAudio.create(format, modelInputLength)
@@ -76,8 +77,8 @@ public static TensorAudio create(TensorAudioFormat format, int sampleCounts) {
   }
 
   /**
-   * Creates a {@link android.media.TensorAudio} instance with a ring buffer whose size is {@code
-   * sampleCounts} * {@code format.getChannelCount()}.
+   * Creates a {@link TensorAudio} instance with a ring buffer whose size is {@code sampleCounts} *
+   * {@code format.getChannelCount()}.
    *
    * @param format the {@link android.media.AudioFormat} required by the TFLite model. It defines
    *     the number of channels and sample rate.

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/FileUtil.java

@@ -130,8 +130,10 @@ public static List<String> loadSingleColumnTextFile(
 
   /**
    * Loads vocabulary from an input stream of an opened vocabulary file (which is a single-column
-   * text file). See details for vocabulary files in {@link FileUtil#loadVocabularyFile(Context,
-   * String)}.
+   * text file).
+   *
+   * <p>A vocabulary file is a single-column plain text file whose contents are split into lines,
+   * and each line is an individual value. The file should be in assets of the context.
    *
    * @param inputStream the input stream of an opened vocabulary file.
    * @return a list of vocabulary words.
@@ -157,7 +159,7 @@ public static MappedByteBuffer loadMappedFile(@NonNull Context context, @NonNull
     SupportPreconditions.checkNotNull(context, "Context should not be null.");
     SupportPreconditions.checkNotNull(filePath, "File path cannot be null.");
     try (AssetFileDescriptor fileDescriptor = context.getAssets().openFd(filePath);
-    FileInputStream inputStream = new FileInputStream(fileDescriptor.getFileDescriptor())) {
+        FileInputStream inputStream = new FileInputStream(fileDescriptor.getFileDescriptor())) {
       FileChannel fileChannel = inputStream.getChannel();
       long startOffset = fileDescriptor.getStartOffset();
       long declaredLength = fileDescriptor.getDeclaredLength();

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/Processor.java

@@ -15,9 +15,7 @@
 
 package org.tensorflow.lite.support.common;
 
-/**
- * Processes T object with prepared {@link Operator<T>}.
- */
+/** Processes T object with prepared {@code Operator<T>}. */
 public interface Processor<T> {
   T process(T input);
 }

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/SequentialProcessor.java

@@ -23,7 +23,7 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * A processor base class that chains a serial of {@link Operator<T>} and executes them.
+ * A processor base class that chains a serial of {@code Operator<T>} and executes them.
  *
  * <p>Typically, users could use its subclasses, e.g. {@link
  * org.tensorflow.lite.support.image.ImageProcessor} rather than directly use this one.

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/SupportPreconditions.java

@@ -144,7 +144,6 @@ public static int checkElementIndex(int index, int size, @Nullable String desc)
    *
    * @param expression a boolean expression
    * @throws IllegalStateException if {@code expression} is false
-   * @see Verify#verify Verify.verify()
    */
   public static void checkState(boolean expression) {
     if (!expression) {
@@ -160,7 +159,6 @@ public static void checkState(boolean expression) {
    * @param errorMessage the exception message to use if the check fails; will be converted to a
    *     string using {@link String#valueOf(Object)}
    * @throws IllegalStateException if {@code expression} is false
-   * @see Verify#verify Verify.verify()
    */
   public static void checkState(boolean expression, @Nullable Object errorMessage) {
     if (!expression) {

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/TensorProcessor.java

@@ -29,7 +29,7 @@
  * </pre>
  *
  * @see TensorProcessor.Builder to build a {@link TensorProcessor} instance.
- * @see TensorProcessor#process(TensorBuffer) to apply the processor on a {@link TensorBuffer}.
+ * @see TensorProcessor#process to apply the processor on a {@link TensorBuffer}.
  */
 public class TensorProcessor extends SequentialProcessor<TensorBuffer> {
   private TensorProcessor(Builder builder) {

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/common/ops/CastOp.java

@@ -34,9 +34,9 @@ public class CastOp implements TensorOperator {
    * <p>When this Op is executed, if the original {@link TensorBuffer} is already in {@code
    * destinationType}, the original buffer will be directly returned.
    *
-   * @param destinationType: The type of the casted {@link TensorBuffer}.
+   * @param destinationType The type of the casted {@link TensorBuffer}.
    * @throws IllegalArgumentException if {@code destinationType} is neither {@link DataType#UINT8}
-   * nor {@link DataType#FLOAT32}.
+   *     nor {@link DataType#FLOAT32}.
    */
   public CastOp(DataType destinationType) {
     SupportPreconditions.checkArgument(

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/image/BoundingBoxUtil.java

@@ -29,8 +29,8 @@
 /**
  * Helper class for converting values that represents bounding boxes into rectangles.
  *
- * <p>The class provides a static function to create bounding boxes as {@link RectF} from different
- * types of configurations.
+ * <p>The class provides a static function to create bounding boxes as {@link
+ * android.graphics.RectF} from different types of configurations.
  *
  * <p>Generally, a bounding box could be represented by 4 float values, but the values could be
  * interpreted in many ways. We now support 3 {@link Type} of configurations, and the order of
@@ -229,8 +229,7 @@ private static RectF getRectF(
       int imageWidth,
       CoordinateType coordinateType) {
     if (coordinateType == CoordinateType.PIXEL) {
-      return new RectF(
-          left, top, right, bottom);
+      return new RectF(left, top, right, bottom);
     } else if (coordinateType == CoordinateType.RATIO) {
       return new RectF(
           left * imageWidth, top * imageHeight, right * imageWidth, bottom * imageHeight);

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/image/ColorSpaceType.java

@@ -159,8 +159,8 @@ int getNumElements(int height, int width) {
   },
 
   /**
-   * YUV420 format corresponding to {@link ImageFormat#YUV_420_888}. The actual encoding format
-   * (i.e. NV12 / Nv21 / YV12 / YV21) depends on the implementation of the image.
+   * YUV420 format corresponding to {@link android.graphics.ImageFormat#YUV_420_888}. The actual
+   * encoding format (i.e. NV12 / Nv21 / YV12 / YV21) depends on the implementation of the image.
    *
    * <p>Use this format only when you load an {@link android.media.Image}.
    */

tensorflow_lite_support/java/src/java/org/tensorflow/lite/support/image/TensorImage.java

@@ -31,15 +31,16 @@
  * <p>At present, only RGB images are supported, and the A channel is always ignored.
  *
  * <p>Details of data storage: a {@link TensorImage} object may have 2 potential sources of truth: a
- * {@link Bitmap} or a {@link TensorBuffer}. {@link TensorImage} maintains the state and only
- * converts one to the other when needed. A typical use case of {@link TensorImage} is to first load
- * a {@link Bitmap} image, then process it using {@link ImageProcessor}, and finally get the
- * underlying {@link ByteBuffer} of the {@link TensorBuffer} and feed it into the TFLite
- * interpreter.
+ * {@link android.graphics.Bitmap} or a {@link TensorBuffer}. {@link TensorImage} maintains the
+ * state and only converts one to the other when needed. A typical use case of {@link TensorImage}
+ * is to first load a {@link android.graphics.Bitmap} image, then process it using {@link
+ * ImageProcessor}, and finally get the underlying {@link ByteBuffer} of the {@link TensorBuffer}
+ * and feed it into the TFLite interpreter.
  *
  * <p>IMPORTANT: to achieve the best performance, {@link TensorImage} avoids copying data whenever
  * it's possible. Therefore, it doesn't own its data. Callers should not modify data objects those
- * are passed to {@link TensorImage#load(Bitmap)} or {@link TensorImage#load(TensorBuffer)}.
+ * are passed to {@link TensorImage#load(Bitmap)} or {@link TensorImage#load(TensorBuffer,
+ * ColorSpaceType)}.
  *
  * <p>IMPORTANT: all methods are not proved thread-safe.
  *
@@ -87,10 +88,11 @@ public TensorImage(DataType dataType) {
   }
 
   /**
-   * Initializes a {@link TensorImage} object of {@link DataType#UINT8} with a {@link Bitmap} .
+   * Initializes a {@link TensorImage} object of {@link DataType#UINT8} with a {@link
+   * android.graphics.Bitmap} .
    *
-   * @see TensorImage#load(Bitmap) for reusing the object when it's expensive to create objects
-   *     frequently, because every call of {@code fromBitmap} creates a new {@link TensorImage}.
+   * @see #load(Bitmap) for reusing the object when it's expensive to create objects frequently,
+   *     because every call of {@code fromBitmap} creates a new {@link TensorImage}.
    */
   public static TensorImage fromBitmap(Bitmap bitmap) {
     TensorImage image = new TensorImage();
@@ -113,11 +115,12 @@ public static TensorImage createFrom(TensorImage src, DataType dataType) {
   }
 
   /**
-   * Loads a {@link Bitmap} image object into this {@link TensorImage}.
+   * Loads a {@link android.graphics.Bitmap} image object into this {@link TensorImage}.
    *
    * <p>Note: if the {@link TensorImage} has data type other than {@link DataType#UINT8}, numeric
    * casting and clamping will be applied when calling {@link #getTensorBuffer} and {@link
-   * #getBuffer}, where the {@link Bitmap} will be converted into a {@link TensorBuffer}.
+   * #getBuffer}, where the {@link android.graphics.Bitmap} will be converted into a {@link
+   * TensorBuffer}.
    *
    * <p>Important: when loading a bitmap, DO NOT MODIFY the bitmap from the caller side anymore. The
    * {@link TensorImage} object will rely on the bitmap. It will probably modify the bitmap as well.
@@ -183,9 +186,9 @@ public void load(TensorBuffer buffer) {
   }
 
   /**
-   * Loads a {@link TensorBuffer} containing pixel values with the specific {@link ColorSapceType}.
+   * Loads a {@link TensorBuffer} containing pixel values with the specific {@link ColorSpaceType}.
    *
-   * <p>Only supports {@link ColorSapceType#RGB} and {@link ColorSpaceType#GRAYSCALE}. Use {@link
+   * <p>Only supports {@link ColorSpaceType#RGB} and {@link ColorSpaceType#GRAYSCALE}. Use {@link
    * #load(TensorBuffer, ImageProperties)} for other color space types.
    *
    * <p>Note: if the data type of {@code buffer} does not match that of this {@link TensorImage},
@@ -196,7 +199,6 @@ public void load(TensorBuffer buffer) {
    *     (1, h, w, 3) for RGB images, and either (h, w) or (1, h, w) for GRAYSCALE images
    * @throws IllegalArgumentException if the shape of buffer does not match the color space type, or
    *     if the color space type is not supported
-   * @see ColorSpaceType#assertShape
    */
   public void load(TensorBuffer buffer, ColorSpaceType colorSpaceType) {
     checkArgument(
@@ -241,22 +243,23 @@ public void load(ByteBuffer buffer, ImageProperties imageProperties) {
   }
 
   /**
-   * Loads an {@link Image} object into this {@link TensorImage}.
+   * Loads an {@link android.media.Image} object into this {@link TensorImage}.
    *
-   * <p>The main usage of this method is to load an {@link Image} object as model input to the <a
-   * href="TFLite Task
+   * <p>The main usage of this method is to load an {@link android.media.Image} object as model
+   * input to the <a href="TFLite Task
    * Library">https://www.tensorflow.org/lite/inference_with_metadata/task_library/overview</a>.
-   * {@link TensorImage} backed by {@link Image} is not supported by {#link ImageProcessor}.
+   * {@link TensorImage} backed by {@link android.media.Image} is not supported by {#link
+   * ImageProcessor}.
    *
-   * <p>* @throws IllegalArgumentException if the {@link ImageFormat} of {@code image} is not
-   * YUV_420_888
+   * <p>* @throws IllegalArgumentException if the {@link android.graphics.ImageFormat} of {@code
+   * image} is not YUV_420_888
    */
   public void load(Image image) {
     container = MediaImageContainer.create(image);
   }
 
   /**
-   * Returns a {@link Bitmap} representation of this {@link TensorImage}.
+   * Returns a {@link android.graphics.Bitmap} representation of this {@link TensorImage}.
    *
    * <p>Numeric casting and clamping will be applied if the stored data is not uint8.
    *
@@ -266,9 +269,9 @@ public void load(Image image) {
    * <p>Important: it's only a reference. DO NOT MODIFY. We don't create a copy here for performance
    * concern, but if modification is necessary, please make a copy.
    *
-   * @return a reference to a {@link Bitmap} in {@code ARGB_8888} config ("A" channel is always
-   *     opaque) or in {@code ALPHA_8}, depending on the {@link ColorSpaceType} of this {@link
-   *     TensorBuffer}.
+   * @return a reference to a {@link android.graphics.Bitmap} in {@code ARGB_8888} config ("A"
+   *     channel is always opaque) or in {@code ALPHA_8}, depending on the {@link ColorSpaceType} of
+   *     this {@link TensorBuffer}.
    * @throws IllegalStateException if the {@link TensorImage} never loads data
    */
   public Bitmap getBitmap() {
@@ -320,17 +323,18 @@ public TensorBuffer getTensorBuffer() {
   }
 
   /**
-   * Returns an {@link Image} representation of this {@link TensorImage}.
+   * Returns an {@link android.media.Image} representation of this {@link TensorImage}.
    *
-   * <p>This method only works when the {@link TensorImage} is backed by an {@link Image}, meaning
-   * you need to first load an {@link Image} through {@link TensorImage#load(Image)}.
+   * <p>This method only works when the {@link TensorImage} is backed by an {@link
+   * android.media.Image}, meaning you need to first load an {@link android.media.Image} through
+   * {@link #load(Image)}.
    *
    * <p>Important: it's only a reference. DO NOT MODIFY. We don't create a copy here for performance
    * concern, but if modification is necessary, please make a copy.
    *
-   * @return a reference to a {@link Bitmap} in {@code ARGB_8888} config ("A" channel is always
-   *     opaque) or in {@code ALPHA_8}, depending on the {@link ColorSpaceType} of this {@link
-   *     TensorBuffer}.
+   * @return a reference to a {@link android.graphics.Bitmap} in {@code ARGB_8888} config ("A"
+   *     channel is always opaque) or in {@code ALPHA_8}, depending on the {@link ColorSpaceType} of
+   *     this {@link TensorBuffer}.
    * @throws IllegalStateException if the {@link TensorImage} never loads data
    */
   public Image getMediaImage() {