diff --git a/library/common/src/main/java/com/google/android/exoplayer2/util/ColorParser.java b/library/common/src/main/java/com/google/android/exoplayer2/util/ColorParser.java index 1200fcb70b..5715cc6bda 100644 --- a/library/common/src/main/java/com/google/android/exoplayer2/util/ColorParser.java +++ b/library/common/src/main/java/com/google/android/exoplayer2/util/ColorParser.java @@ -27,8 +27,12 @@ import java.util.regex.Pattern; /** * Parser for color expressions found in styling formats, e.g. TTML and CSS. * - * @see WebVTT CSS Styling - * @see Timed Text Markup Language 2 (TTML2) - 10.3.5 + *

See also: + * + *

*/ public final class ColorParser { diff --git a/library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java b/library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java index 198aa0057e..ab114bb093 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java @@ -29,8 +29,12 @@ import java.util.Comparator; * rate observations. This is an alternative to sliding mean and exponential averaging which suffer * from susceptibility to outliers and slow adaptation to step functions. * - * @see Wiki: Moving average - * @see Wiki: Selection algorithm + *

See the following Wikipedia articles: + * + *

*/ public class SlidingPercentile { diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/FlacStreamMetadata.java b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/FlacStreamMetadata.java index 48e521b413..b6a71e30ff 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/FlacStreamMetadata.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/FlacStreamMetadata.java @@ -32,14 +32,18 @@ import java.util.List; /** * Holder for FLAC metadata. * - * @see FLAC format - * METADATA_BLOCK_STREAMINFO - * @see FLAC format - * METADATA_BLOCK_SEEKTABLE - * @see FLAC format - * METADATA_BLOCK_VORBIS_COMMENT - * @see FLAC format - * METADATA_BLOCK_PICTURE + *

See the following spec references: + * + *

*/ public final class FlacStreamMetadata { diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisBitArray.java b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisBitArray.java index 56f419a184..7fa3e0dc4c 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisBitArray.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisBitArray.java @@ -22,8 +22,8 @@ import com.google.android.exoplayer2.util.Assertions; /** * Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream. * - * @see Vorbis bitpacking - * specification + *

See the Vorbis + * bitpacking specification */ public final class VorbisBitArray { diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisUtil.java b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisUtil.java index ed02771fe5..f4d1b605c4 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisUtil.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisUtil.java @@ -50,8 +50,8 @@ public final class VorbisUtil { /** * Vorbis identification header. * - * @see Vorbis - * spec/Identification header + *

See the Vorbis + * spec/Identification header */ public static final class VorbisIdHeader { @@ -133,8 +133,9 @@ public final class VorbisUtil { /** * Returns ilog(x), which is the index of the highest set bit in {@code x}. * - * @see Vorbis - * spec + *

See the Vorbis + * spec + * * @param x the value of which the ilog should be calculated. * @return ilog(x) */ @@ -150,8 +151,9 @@ public final class VorbisUtil { /** * Reads a Vorbis identification header from {@code headerData}. * - * @see Vorbis - * spec/Identification header + *

See the Vorbis + * spec/Identification header + * * @param headerData a {@link ParsableByteArray} wrapping the header data. * @return a {@link VorbisUtil.VorbisIdHeader} with meta data. * @throws ParserException thrown if invalid capture pattern is detected. @@ -200,8 +202,9 @@ public final class VorbisUtil { /** * Reads a Vorbis comment header. * - * @see Vorbis - * spec/Comment header + *

See the Vorbis + * spec/Comment header + * * @param headerData A {@link ParsableByteArray} wrapping the header data. * @return A {@link VorbisUtil.CommentHeader} with all the comments. * @throws ParserException If an error occurs parsing the comment header. @@ -217,8 +220,9 @@ public final class VorbisUtil { * *

The data provided may not contain the Vorbis metadata common header and the framing bit. * - * @see Vorbis - * spec/Comment header + *

See the Vorbis + * spec/Comment header + * * @param headerData A {@link ParsableByteArray} wrapping the header data. * @param hasMetadataHeader Whether the {@code headerData} contains a Vorbis metadata common * header preceding the comment header. @@ -347,8 +351,9 @@ public final class VorbisUtil { * That's why we need to partially decode or at least read the entire setup header to know where * to start reading the modes. * - * @see Vorbis - * spec/Setup header + *

See the Vorbis + * spec/Setup header + * * @param headerData a {@link ParsableByteArray} containing setup header data. * @param channels the number of channels. * @return an array of {@link Mode}s. @@ -590,7 +595,8 @@ public final class VorbisUtil { } /** - * @see _book_maptype1_quantvals + * See the _book_maptype1_quantvals */ private static long mapType1QuantValues(long entries, long dimension) { return (long) Math.floor(Math.pow(entries, 1.d / dimension)); diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java b/library/extractor/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java index 272fa7734f..5a7fb6210d 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java @@ -64,7 +64,7 @@ import org.xmlpull.v1.XmlPullParserFactory; *

  • cell-resolution * * - * @see TTML specification + *

    See the TTML specification */ public final class TtmlDecoder extends SimpleSubtitleDecoder { diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.java b/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.java index 2fbd266e3c..2f4300acac 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.java @@ -35,10 +35,10 @@ import java.util.HashSet; import java.util.Set; /** - * Style object of a Css style block in a Webvtt file. + * Style object of a CSS style block in a WebVTT file. * - * @see W3C specification - Apply - * CSS properties + *

    See the Apply CSS properties + * section of the W3C specification */ public final class WebvttCssStyle { diff --git a/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttDecoder.java b/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttDecoder.java index 2e3a7fdafc..7eb771d34e 100644 --- a/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttDecoder.java +++ b/library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttDecoder.java @@ -28,7 +28,7 @@ import java.util.List; /** * A {@link SimpleSubtitleDecoder} for WebVTT. * - * @see WebVTT specification + *

    See the WebVTT specification. */ public final class WebvttDecoder extends SimpleSubtitleDecoder { diff --git a/library/extractor/src/test/java/com/google/android/exoplayer2/text/ttml/TtmlDecoderTest.java b/library/extractor/src/test/java/com/google/android/exoplayer2/text/ttml/TtmlDecoderTest.java index 67b4ec64b7..b8d613b295 100644 --- a/library/extractor/src/test/java/com/google/android/exoplayer2/text/ttml/TtmlDecoderTest.java +++ b/library/extractor/src/test/java/com/google/android/exoplayer2/text/ttml/TtmlDecoderTest.java @@ -112,14 +112,11 @@ public final class TtmlDecoderTest { * Regression test for devices on JellyBean where some named colors are not correctly defined on * framework level. Tests that lime resolves to #FF00FF00 not #00FF00 * . - * - * @throws IOException thrown if reading subtitle file fails. - * @see - * JellyBean Color - * Kitkat Color */ + // JellyBean Color: + // https://github.com/android/platform_frameworks_base/blob/jb-mr2-release/graphics/java/android/graphics/Color.java#L414 + // KitKat Color: + // https://github.com/android/platform_frameworks_base/blob/kitkat-mr2.2-release/graphics/java/android/graphics/Color.java#L414 @Test public void lime() throws IOException, SubtitleDecoderException { TtmlSubtitle subtitle = getSubtitle(INLINE_ATTRIBUTES_TTML_FILE); diff --git a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifest.java b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifest.java index d7acee8b97..6876945fe6 100644 --- a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifest.java +++ b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifest.java @@ -33,8 +33,8 @@ import java.util.UUID; /** * Represents a SmoothStreaming manifest. * - * @see IIS Smooth - * Streaming Client Manifest Format + *

    See the IIS Smooth + * Streaming Client Manifest Format */ public class SsManifest implements FilterableManifest { diff --git a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java index 0b07f3a248..40e11ee2b7 100644 --- a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java +++ b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java @@ -50,8 +50,8 @@ import org.xmlpull.v1.XmlPullParserFactory; /** * Parses SmoothStreaming client manifests. * - * @see IIS Smooth - * Streaming Client Manifest Format + *

    See the IIS Smooth + * Streaming Client Manifest Format */ public class SsManifestParser implements ParsingLoadable.Parser { diff --git a/library/transformer/src/main/java/com/google/android/exoplayer2/transformer/MssimCalculator.java b/library/transformer/src/main/java/com/google/android/exoplayer2/transformer/MssimCalculator.java index c3d4371fdf..ee41bc0f5e 100644 --- a/library/transformer/src/main/java/com/google/android/exoplayer2/transformer/MssimCalculator.java +++ b/library/transformer/src/main/java/com/google/android/exoplayer2/transformer/MssimCalculator.java @@ -23,7 +23,7 @@ import static java.lang.Math.pow; * *

    MSSIM divides the image into windows, calculates SSIM of each, then returns the average. * - * @see The SSIM paper. + *

    See the SSIM paper. */ /* package */ final class MssimCalculator { // Referred to as 'L' in the SSIM paper, this constant defines the maximum pixel values. The