Use @link instead of @value

Dackka doesn't support `@value` #minor-release PiperOrigin-RevId: 524309695
2023-04-14 17:25:49 +01:00 · 2023-04-14 17:25:49 +01:00 · b834e49f9f
commit b834e49f9f
parent 9c5fca8e65
5 changed files with 15 additions and 15 deletions
--- a/demos/transformer/src/main/java/androidx/media3/demo/transformer/MatrixTransformationFactory.java
+++ b/demos/transformer/src/main/java/androidx/media3/demo/transformer/MatrixTransformationFactory.java
@ -28,7 +28,7 @@ import androidx.media3.effect.MatrixTransformation;
 */
 /* package */ final class MatrixTransformationFactory {
  /**
-   * Returns a {@link MatrixTransformation} that rescales the frames over the first {@value
+   * Returns a {@link MatrixTransformation} that rescales the frames over the first {@link
   * #ZOOM_DURATION_SECONDS} seconds, such that the rectangle filled with the input frame increases
   * linearly in size from a single point to filling the full output frame.
   */
--- a/libraries/common/src/main/java/androidx/media3/common/AuxEffectInfo.java
+++ b/libraries/common/src/main/java/androidx/media3/common/AuxEffectInfo.java
@ -52,12 +52,12 @@ public final class AuxEffectInfo {
   * Creates an instance with the given effect identifier and send level.
   *
   * @param effectId The effect identifier. This is the value returned by {@link
-   *     AudioEffect#getId()} on the effect, or {@value #NO_AUX_EFFECT_ID} which represents no
+   *     AudioEffect#getId()} on the effect, or {@link #NO_AUX_EFFECT_ID} which represents no
   *     effect. This value is passed to {@link AudioTrack#attachAuxEffect(int)} on the underlying
   *     audio track.
   * @param sendLevel The send level for the effect, where 0 represents no effect and a value of 1
-   *     is full send. If {@code effectId} is not {@value #NO_AUX_EFFECT_ID}, this value is passed
-   *     to {@link AudioTrack#setAuxEffectSendLevel(float)} on the underlying audio track.
+   *     is full send. If {@code effectId} is not {@link #NO_AUX_EFFECT_ID}, this value is passed to
+   *     {@link AudioTrack#setAuxEffectSendLevel(float)} on the underlying audio track.
   */
  public AuxEffectInfo(int effectId, float sendLevel) {
    this.effectId = effectId;
--- a/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java
+++ b/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java
@ -152,7 +152,7 @@ public final class GlUtil {
  }

  /**
-   * Returns whether creating a GL context with {@value #EXTENSION_PROTECTED_CONTENT} is possible.
+   * Returns whether creating a GL context with {@link #EXTENSION_PROTECTED_CONTENT} is possible.
   *
   * <p>If {@code true}, the device supports a protected output path for DRM content when using GL.
   */
@ -181,7 +181,7 @@ public final class GlUtil {
  }

  /**
-   * Returns whether the {@value #EXTENSION_SURFACELESS_CONTEXT} extension is supported.
+   * Returns whether the {@link #EXTENSION_SURFACELESS_CONTEXT} extension is supported.
   *
   * <p>This extension allows passing {@link EGL14#EGL_NO_SURFACE} for both the write and read
   * surfaces in a call to {@link EGL14#eglMakeCurrent(EGLDisplay, EGLSurface, EGLSurface,
@ -197,7 +197,7 @@ public final class GlUtil {
  }

  /**
-   * Returns whether the {@value #EXTENSION_YUV_TARGET} extension is supported.
+   * Returns whether the {@link #EXTENSION_YUV_TARGET} extension is supported.
   *
   * <p>This extension allows sampling raw YUV values from an external texture, which is required
   * for HDR input.
@ -226,7 +226,7 @@ public final class GlUtil {
    return glExtensions != null && glExtensions.contains(EXTENSION_YUV_TARGET);
  }

-  /** Returns whether {@value #EXTENSION_COLORSPACE_BT2020_PQ} is supported. */
+  /** Returns whether {@link #EXTENSION_COLORSPACE_BT2020_PQ} is supported. */
  public static boolean isBt2020PqExtensionSupported() {
    EGLDisplay display = EGL14.eglGetDisplay(EGL14.EGL_DEFAULT_DISPLAY);
    @Nullable String eglExtensions = EGL14.eglQueryString(display, EGL10.EGL_EXTENSIONS);
--- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioTrackBufferSizeProvider.java
+++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioTrackBufferSizeProvider.java
@ -80,7 +80,7 @@ public class DefaultAudioTrackBufferSizeProvider

    /**
     * Sets the minimum length for PCM {@link AudioTrack} buffers, in microseconds. Default is
-     * {@value #MIN_PCM_BUFFER_DURATION_US}.
+     * {@link #MIN_PCM_BUFFER_DURATION_US}.
     */
    @CanIgnoreReturnValue
    public Builder setMinPcmBufferDurationUs(int minPcmBufferDurationUs) {
@ -90,7 +90,7 @@ public class DefaultAudioTrackBufferSizeProvider

    /**
     * Sets the maximum length for PCM {@link AudioTrack} buffers, in microseconds. Default is
-     * {@value #MAX_PCM_BUFFER_DURATION_US}.
+     * {@link #MAX_PCM_BUFFER_DURATION_US}.
     */
    @CanIgnoreReturnValue
    public Builder setMaxPcmBufferDurationUs(int maxPcmBufferDurationUs) {
@ -100,7 +100,7 @@ public class DefaultAudioTrackBufferSizeProvider

    /**
     * Sets the multiplication factor to apply to the minimum buffer size requested. Default is
-     * {@value #PCM_BUFFER_MULTIPLICATION_FACTOR}.
+     * {@link #PCM_BUFFER_MULTIPLICATION_FACTOR}.
     */
    @CanIgnoreReturnValue
    public Builder setPcmBufferMultiplicationFactor(int pcmBufferMultiplicationFactor) {
@ -110,7 +110,7 @@ public class DefaultAudioTrackBufferSizeProvider

    /**
     * Sets the length for passthrough {@link AudioTrack} buffers, in microseconds. Default is
-     * {@value #PASSTHROUGH_BUFFER_DURATION_US}.
+     * {@link #PASSTHROUGH_BUFFER_DURATION_US}.
     */
    @CanIgnoreReturnValue
    public Builder setPassthroughBufferDurationUs(int passthroughBufferDurationUs) {
@ -119,7 +119,7 @@ public class DefaultAudioTrackBufferSizeProvider
    }

    /**
-     * The length for offload {@link AudioTrack} buffers, in microseconds. Default is {@value
+     * The length for offload {@link AudioTrack} buffers, in microseconds. Default is {@link
     * #OFFLOAD_BUFFER_DURATION_US}.
     */
    @CanIgnoreReturnValue
@ -130,7 +130,7 @@ public class DefaultAudioTrackBufferSizeProvider

    /**
     * Sets the multiplication factor to apply to the passthrough buffer for AC3 to avoid underruns
-     * on some devices (e.g., Broadcom 7271). Default is {@value #AC3_BUFFER_MULTIPLICATION_FACTOR}.
+     * on some devices (e.g., Broadcom 7271). Default is {@link #AC3_BUFFER_MULTIPLICATION_FACTOR}.
     */
    @CanIgnoreReturnValue
    public Builder setAc3BufferMultiplicationFactor(int ac3BufferMultiplicationFactor) {
--- a/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java
+++ b/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java
@ -273,7 +273,7 @@ public final class ImaAdsLoader implements AdsLoader {
    /**
     * Sets the duration in milliseconds for which the player must buffer while preloading an ad
     * group before that ad group is skipped and marked as having failed to load. Pass {@link
-     * C#TIME_UNSET} if there should be no such timeout. The default value is {@value
+     * C#TIME_UNSET} if there should be no such timeout. The default value is {@link
     * #DEFAULT_AD_PRELOAD_TIMEOUT_MS} ms.
     *
     * <p>The purpose of this timeout is to avoid playback getting stuck in the unexpected case that