From d5a81c5c4100298c96bf10734e6bd034bc19ff5b Mon Sep 17 00:00:00 2001 From: ibaker Date: Fri, 14 Apr 2023 17:25:49 +0100 Subject: [PATCH] Use `@link` instead of `@value` Dackka doesn't support `@value` PiperOrigin-RevId: 524309695 (cherry picked from commit b834e49f9ff1b3777e5b69c609b9eed83e9e6a5f) --- .../transformer/MatrixTransformationFactory.java | 2 +- .../java/androidx/media3/common/AuxEffectInfo.java | 6 +++--- .../java/androidx/media3/common/util/GlUtil.java | 6 +++--- .../audio/DefaultAudioTrackBufferSizeProvider.java | 12 ++++++------ .../androidx/media3/exoplayer/ima/ImaAdsLoader.java | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/demos/transformer/src/main/java/androidx/media3/demo/transformer/MatrixTransformationFactory.java b/demos/transformer/src/main/java/androidx/media3/demo/transformer/MatrixTransformationFactory.java index 0f31a589c9..f4682e249c 100644 --- 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. */ diff --git a/libraries/common/src/main/java/androidx/media3/common/AuxEffectInfo.java b/libraries/common/src/main/java/androidx/media3/common/AuxEffectInfo.java index c51844ed75..a94f1afcaf 100644 --- 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; diff --git a/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java b/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java index 128f708d29..216a01adc1 100644 --- a/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java +++ b/libraries/common/src/main/java/androidx/media3/common/util/GlUtil.java @@ -142,7 +142,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. * *

If {@code true}, the device supports a protected output path for DRM content when using GL. */ @@ -171,7 +171,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. * *

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, @@ -187,7 +187,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. * *

This extension allows sampling raw YUV values from an external texture, which is required * for HDR. diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioTrackBufferSizeProvider.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioTrackBufferSizeProvider.java index ef40d2c4c1..e0f117d222 100644 --- 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) { diff --git 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 index f90654a290..5ce9df28ca 100644 --- 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. * *

The purpose of this timeout is to avoid playback getting stuck in the unexpected case that