Skip to content

SDK / exoplayer

Go to a project
Commit a834d053 by ibaker Committed by tonihei
Options

Remove @see tags with <a> tags 

These are not supported by Dackka

#minor-release

PiperOrigin-RevId: 513176533
(cherry picked from commit ef5a1ce9)
parent bfc12ef5
Inline Side-by-side
Showing with 47 additions and 32 deletions
library/common/src/main/java/com/google/android/exoplayer2/util/ColorParser.java
...@@ -27,8 +27,12 @@ import java.util.regex.Pattern; ...@@ -27,8 +27,12 @@ import java.util.regex.Pattern;
/** /**
* Parser for color expressions found in styling formats, e.g. TTML and CSS. * Parser for color expressions found in styling formats, e.g. TTML and CSS.
* *
* @see <a href="https://w3c.github.io/webvtt/#styling">WebVTT CSS Styling</a> * <p>See also:
* @see <a href="https://www.w3.org/TR/ttml2/">Timed Text Markup Language 2 (TTML2) - 10.3.5</a> *
* <ul>
* <li><a href="https://w3c.github.io/webvtt/#styling">WebVTT CSS Styling</a>
* <li><a href="https://www.w3.org/TR/ttml2/">Timed Text Markup Language 2 (TTML2) - 10.3.5</a>
* </ul>
*/ */
public final class ColorParser { public final class ColorParser {
......
library/core/src/main/java/com/google/android/exoplayer2/upstream/SlidingPercentile.java
...@@ -29,8 +29,12 @@ import java.util.Comparator; ...@@ -29,8 +29,12 @@ import java.util.Comparator;
* rate observations. This is an alternative to sliding mean and exponential averaging which suffer * rate observations. This is an alternative to sliding mean and exponential averaging which suffer
* from susceptibility to outliers and slow adaptation to step functions. * from susceptibility to outliers and slow adaptation to step functions.
* *
* @see <a href="http://en.wikipedia.org/wiki/Moving_average">Wiki: Moving average</a> * <p>See the following Wikipedia articles:
* @see <a href="http://en.wikipedia.org/wiki/Selection_algorithm">Wiki: Selection algorithm</a> *
* <ul>
* <li><a href="http://en.wikipedia.org/wiki/Moving_average">Moving average</a>
* <li><a href="http://en.wikipedia.org/wiki/Selection_algorithm">Selection algorithm</a>
* </ul>
*/ */
public class SlidingPercentile { public class SlidingPercentile {
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/FlacStreamMetadata.java
...@@ -32,14 +32,18 @@ import java.util.List; ...@@ -32,14 +32,18 @@ import java.util.List;
/** /**
* Holder for FLAC metadata. * Holder for FLAC metadata.
* *
* @see <a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format * <p>See the following spec references:
*
* <ul>
* <li><a href="https://xiph.org/flac/format.html#metadata_block_streaminfo">FLAC format
* METADATA_BLOCK_STREAMINFO</a> * METADATA_BLOCK_STREAMINFO</a>
* @see <a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format * <li><a href="https://xiph.org/flac/format.html#metadata_block_seektable">FLAC format
* METADATA_BLOCK_SEEKTABLE</a> * METADATA_BLOCK_SEEKTABLE</a>
* @see <a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format * <li><a href="https://xiph.org/flac/format.html#metadata_block_vorbis_comment">FLAC format
* METADATA_BLOCK_VORBIS_COMMENT</a> * METADATA_BLOCK_VORBIS_COMMENT</a>
* @see <a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format * <li><a href="https://xiph.org/flac/format.html#metadata_block_picture">FLAC format
* METADATA_BLOCK_PICTURE</a> * METADATA_BLOCK_PICTURE</a>
* </ul>
*/ */
public final class FlacStreamMetadata { public final class FlacStreamMetadata {
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisBitArray.java
...@@ -22,8 +22,8 @@ import com.google.android.exoplayer2.util.Assertions; ...@@ -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. * Wraps a byte array, providing methods that allow it to be read as a Vorbis bitstream.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis bitpacking * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-360002">Vorbis
* specification</a> * bitpacking specification</a>
*/ */
public final class VorbisBitArray { public final class VorbisBitArray {
......
library/extractor/src/main/java/com/google/android/exoplayer2/extractor/VorbisUtil.java
...@@ -50,7 +50,7 @@ public final class VorbisUtil { ...@@ -50,7 +50,7 @@ public final class VorbisUtil {
/** /**
* Vorbis identification header. * Vorbis identification header.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
* spec/Identification header</a> * spec/Identification header</a>
*/ */
public static final class VorbisIdHeader { public static final class VorbisIdHeader {
...@@ -133,8 +133,9 @@ public final class VorbisUtil { ...@@ -133,8 +133,9 @@ public final class VorbisUtil {
/** /**
* Returns ilog(x), which is the index of the highest set bit in {@code x}. * Returns ilog(x), which is the index of the highest set bit in {@code x}.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-1190009.2.1">Vorbis
* spec</a> * spec</a>
*
* @param x the value of which the ilog should be calculated. * @param x the value of which the ilog should be calculated.
* @return ilog(x) * @return ilog(x)
*/ */
...@@ -150,8 +151,9 @@ public final class VorbisUtil { ...@@ -150,8 +151,9 @@ public final class VorbisUtil {
/** /**
* Reads a Vorbis identification header from {@code headerData}. * Reads a Vorbis identification header from {@code headerData}.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-630004.2.2">Vorbis
* spec/Identification header</a> * spec/Identification header</a>
*
* @param headerData a {@link ParsableByteArray} wrapping the header data. * @param headerData a {@link ParsableByteArray} wrapping the header data.
* @return a {@link VorbisUtil.VorbisIdHeader} with meta data. * @return a {@link VorbisUtil.VorbisIdHeader} with meta data.
* @throws ParserException thrown if invalid capture pattern is detected. * @throws ParserException thrown if invalid capture pattern is detected.
...@@ -200,8 +202,9 @@ public final class VorbisUtil { ...@@ -200,8 +202,9 @@ public final class VorbisUtil {
/** /**
* Reads a Vorbis comment header. * Reads a Vorbis comment header.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
* spec/Comment header</a> * spec/Comment header</a>
*
* @param headerData A {@link ParsableByteArray} wrapping the header data. * @param headerData A {@link ParsableByteArray} wrapping the header data.
* @return A {@link VorbisUtil.CommentHeader} with all the comments. * @return A {@link VorbisUtil.CommentHeader} with all the comments.
* @throws ParserException If an error occurs parsing the comment header. * @throws ParserException If an error occurs parsing the comment header.
...@@ -217,8 +220,9 @@ public final class VorbisUtil { ...@@ -217,8 +220,9 @@ public final class VorbisUtil {
* *
* <p>The data provided may not contain the Vorbis metadata common header and the framing bit. * <p>The data provided may not contain the Vorbis metadata common header and the framing bit.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-640004.2.3">Vorbis
* spec/Comment header</a> * spec/Comment header</a>
*
* @param headerData A {@link ParsableByteArray} wrapping the header data. * @param headerData A {@link ParsableByteArray} wrapping the header data.
* @param hasMetadataHeader Whether the {@code headerData} contains a Vorbis metadata common * @param hasMetadataHeader Whether the {@code headerData} contains a Vorbis metadata common
* header preceding the comment header. * header preceding the comment header.
...@@ -347,8 +351,9 @@ public final class VorbisUtil { ...@@ -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 * That's why we need to partially decode or at least read the entire setup header to know where
* to start reading the modes. * to start reading the modes.
* *
* @see <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis * <p>See the <a href="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-650004.2.4">Vorbis
* spec/Setup header</a> * spec/Setup header</a>
*
* @param headerData a {@link ParsableByteArray} containing setup header data. * @param headerData a {@link ParsableByteArray} containing setup header data.
* @param channels the number of channels. * @param channels the number of channels.
* @return an array of {@link Mode}s. * @return an array of {@link Mode}s.
...@@ -590,7 +595,8 @@ public final class VorbisUtil { ...@@ -590,7 +595,8 @@ public final class VorbisUtil {
} }
/** /**
* @see <a href="http://svn.xiph.org/trunk/vorbis/lib/sharedbook.c">_book_maptype1_quantvals</a> * See the <a
* href="http://svn.xiph.org/trunk/vorbis/lib/sharedbook.c">_book_maptype1_quantvals</a>
*/ */
private static long mapType1QuantValues(long entries, long dimension) { private static long mapType1QuantValues(long entries, long dimension) {
return (long) Math.floor(Math.pow(entries, 1.d / dimension)); return (long) Math.floor(Math.pow(entries, 1.d / dimension));
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java
...@@ -64,7 +64,7 @@ import org.xmlpull.v1.XmlPullParserFactory; ...@@ -64,7 +64,7 @@ import org.xmlpull.v1.XmlPullParserFactory;
* <li>cell-resolution * <li>cell-resolution
* </ul> * </ul>
* *
* @see <a href="http://www.w3.org/TR/ttaf1-dfxp/">TTML specification</a> * <p>See the <a href="http://www.w3.org/TR/ttaf1-dfxp/">TTML specification</a>
*/ */
public final class TtmlDecoder extends SimpleSubtitleDecoder { public final class TtmlDecoder extends SimpleSubtitleDecoder {
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttCssStyle.java
...@@ -35,10 +35,10 @@ import java.util.HashSet; ...@@ -35,10 +35,10 @@ import java.util.HashSet;
import java.util.Set; 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 <a href="https://w3c.github.io/webvtt/#applying-css-properties">W3C specification - Apply * <p>See the <a href="https://w3c.github.io/webvtt/#applying-css-properties">Apply CSS properties
* CSS properties</a> * section of the W3C specification</a>
*/ */
public final class WebvttCssStyle { public final class WebvttCssStyle {
......
library/extractor/src/main/java/com/google/android/exoplayer2/text/webvtt/WebvttDecoder.java
...@@ -28,7 +28,7 @@ import java.util.List; ...@@ -28,7 +28,7 @@ import java.util.List;
/** /**
* A {@link SimpleSubtitleDecoder} for WebVTT. * A {@link SimpleSubtitleDecoder} for WebVTT.
* *
* @see <a href="http://dev.w3.org/html5/webvtt">WebVTT specification</a> * <p>See the <a href="http://dev.w3.org/html5/webvtt">WebVTT specification</a>.
*/ */
public final class WebvttDecoder extends SimpleSubtitleDecoder { public final class WebvttDecoder extends SimpleSubtitleDecoder {
......
library/extractor/src/test/java/com/google/android/exoplayer2/text/ttml/TtmlDecoderTest.java
...@@ -112,14 +112,11 @@ public final class TtmlDecoderTest { ...@@ -112,14 +112,11 @@ public final class TtmlDecoderTest {
* Regression test for devices on JellyBean where some named colors are not correctly defined on * Regression test for devices on JellyBean where some named colors are not correctly defined on
* framework level. Tests that <i>lime</i> resolves to <code>#FF00FF00</code> not <code>#00FF00 * framework level. Tests that <i>lime</i> resolves to <code>#FF00FF00</code> not <code>#00FF00
* </code>. * </code>.
*
* @throws IOException thrown if reading subtitle file fails.
* @see <a
* href="https://github.com/android/platform_frameworks_base/blob/jb-mr2-release/graphics/java/android/graphics/Color.java#L414">
* JellyBean Color</a> <a
* href="https://github.com/android/platform_frameworks_base/blob/kitkat-mr2.2-release/graphics/java/android/graphics/Color.java#L414">
* Kitkat Color</a>
*/ */
// 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 @Test
public void lime() throws IOException, SubtitleDecoderException { public void lime() throws IOException, SubtitleDecoderException {
TtmlSubtitle subtitle = getSubtitle(INLINE_ATTRIBUTES_TTML_FILE); TtmlSubtitle subtitle = getSubtitle(INLINE_ATTRIBUTES_TTML_FILE);
......
library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifest.java
...@@ -33,7 +33,7 @@ import java.util.UUID; ...@@ -33,7 +33,7 @@ import java.util.UUID;
/** /**
* Represents a SmoothStreaming manifest. * Represents a SmoothStreaming manifest.
* *
* @see <a href="http://msdn.microsoft.com/en-us/library/ee673436(v=vs.90).aspx">IIS Smooth * <p>See the <a href="http://msdn.microsoft.com/en-us/library/ee673436(v=vs.90).aspx">IIS Smooth
* Streaming Client Manifest Format</a> * Streaming Client Manifest Format</a>
*/ */
public class SsManifest implements FilterableManifest<SsManifest> { public class SsManifest implements FilterableManifest<SsManifest> {
......
library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/manifest/SsManifestParser.java
...@@ -50,7 +50,7 @@ import org.xmlpull.v1.XmlPullParserFactory; ...@@ -50,7 +50,7 @@ import org.xmlpull.v1.XmlPullParserFactory;
/** /**
* Parses SmoothStreaming client manifests. * Parses SmoothStreaming client manifests.
* *
* @see <a href="http://msdn.microsoft.com/en-us/library/ee673436(v=vs.90).aspx">IIS Smooth * <p>See the <a href="http://msdn.microsoft.com/en-us/library/ee673436(v=vs.90).aspx">IIS Smooth
* Streaming Client Manifest Format</a> * Streaming Client Manifest Format</a>
*/ */
public class SsManifestParser implements ParsingLoadable.Parser<SsManifest> { public class SsManifestParser implements ParsingLoadable.Parser<SsManifest> {
......
library/transformer/src/main/java/com/google/android/exoplayer2/transformer/MssimCalculator.java
...@@ -23,7 +23,7 @@ import static java.lang.Math.pow; ...@@ -23,7 +23,7 @@ import static java.lang.Math.pow;
* *
* <p>MSSIM divides the image into windows, calculates SSIM of each, then returns the average. * <p>MSSIM divides the image into windows, calculates SSIM of each, then returns the average.
* *
* @see <a href=https://ece.uwaterloo.ca/~z70wang/publications/ssim.pdf>The SSIM paper</a>. * <p>See <a href=https://ece.uwaterloo.ca/~z70wang/publications/ssim.pdf>the SSIM paper</a>.
*/ */
/* package */ final class MssimCalculator { /* package */ final class MssimCalculator {
// Referred to as 'L' in the SSIM paper, this constant defines the maximum pixel values. The // Referred to as 'L' in the SSIM paper, this constant defines the maximum pixel values. The
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment