Reformat some javadoc

PiperOrigin-RevId: 371068549
This commit is contained in:
ibaker 2021-04-29 09:05:15 +01:00 committed by bachinger
parent d8da136d0f
commit cfec557ff0
15 changed files with 20 additions and 46 deletions

View File

@ -17,9 +17,7 @@ package com.google.android.exoplayer2.decoder;
import com.google.android.exoplayer2.C; import com.google.android.exoplayer2.C;
/** /** Base class for buffers with flags. */
* Base class for buffers with flags.
*/
public abstract class Buffer { public abstract class Buffer {
@C.BufferFlags @C.BufferFlags

View File

@ -17,9 +17,7 @@ package com.google.android.exoplayer2.metadata.id3;
import com.google.android.exoplayer2.metadata.Metadata; import com.google.android.exoplayer2.metadata.Metadata;
/** /** Base class for ID3 frames. */
* Base class for ID3 frames.
*/
public abstract class Id3Frame implements Metadata.Entry { public abstract class Id3Frame implements Metadata.Entry {
/** /**

View File

@ -27,9 +27,7 @@ import com.google.android.exoplayer2.util.Assertions;
import com.google.android.exoplayer2.util.MediaClock; import com.google.android.exoplayer2.util.MediaClock;
import java.io.IOException; import java.io.IOException;
/** /** An abstract base class suitable for most {@link Renderer} implementations. */
* An abstract base class suitable for most {@link Renderer} implementations.
*/
public abstract class BaseRenderer implements Renderer, RendererCapabilities { public abstract class BaseRenderer implements Renderer, RendererCapabilities {
private final int trackType; private final int trackType;

View File

@ -15,9 +15,7 @@
*/ */
package com.google.android.exoplayer2.decoder; package com.google.android.exoplayer2.decoder;
/** /** Output buffer decoded by a {@link Decoder}. */
* Output buffer decoded by a {@link Decoder}.
*/
public abstract class OutputBuffer extends Buffer { public abstract class OutputBuffer extends Buffer {
/** Buffer owner. */ /** Buffer owner. */

View File

@ -79,9 +79,7 @@ import java.util.ArrayDeque;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /** An abstract renderer that uses {@link MediaCodec} to decode samples for rendering. */
* An abstract renderer that uses {@link MediaCodec} to decode samples for rendering.
*/
public abstract class MediaCodecRenderer extends BaseRenderer { public abstract class MediaCodecRenderer extends BaseRenderer {
/** Thrown when a failure occurs instantiating a decoder. */ /** Thrown when a failure occurs instantiating a decoder. */

View File

@ -17,9 +17,7 @@ package com.google.android.exoplayer2.metadata.scte35;
import com.google.android.exoplayer2.metadata.Metadata; import com.google.android.exoplayer2.metadata.Metadata;
/** /** Superclass for SCTE35 splice commands. */
* Superclass for SCTE35 splice commands.
*/
public abstract class SpliceCommand implements Metadata.Entry { public abstract class SpliceCommand implements Metadata.Entry {
@Override @Override

View File

@ -18,9 +18,7 @@ package com.google.android.exoplayer2.source;
import com.google.android.exoplayer2.Player; import com.google.android.exoplayer2.Player;
import com.google.android.exoplayer2.Timeline; import com.google.android.exoplayer2.Timeline;
/** /** An overridable {@link Timeline} implementation forwarding all methods to another timeline. */
* An overridable {@link Timeline} implementation forwarding all methods to another timeline.
*/
public abstract class ForwardingTimeline extends Timeline { public abstract class ForwardingTimeline extends Timeline {
protected final Timeline timeline; protected final Timeline timeline;

View File

@ -23,9 +23,7 @@ import com.google.android.exoplayer2.upstream.DataSpec;
import com.google.android.exoplayer2.util.Assertions; import com.google.android.exoplayer2.util.Assertions;
import org.checkerframework.checker.nullness.qual.MonotonicNonNull; import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
/** /** A base implementation of {@link MediaChunk} that outputs to a {@link BaseMediaChunkOutput}. */
* A base implementation of {@link MediaChunk} that outputs to a {@link BaseMediaChunkOutput}.
*/
public abstract class BaseMediaChunk extends MediaChunk { public abstract class BaseMediaChunk extends MediaChunk {
/** /**

View File

@ -29,8 +29,8 @@ import java.util.List;
import java.util.Map; import java.util.Map;
/** /**
* An abstract base class for {@link Loadable} implementations that load chunks of data required * An abstract base class for {@link Loadable} implementations that load chunks of data required for
* for the playback of streams. * the playback of streams.
*/ */
public abstract class Chunk implements Loadable { public abstract class Chunk implements Loadable {

View File

@ -25,8 +25,8 @@ import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
/** /**
* A base class for {@link Chunk} implementations where the data should be loaded into a * A base class for {@link Chunk} implementations where the data should be loaded into a {@code
* {@code byte[]} before being consumed. * byte[]} before being consumed.
*/ */
public abstract class DataChunk extends Chunk { public abstract class DataChunk extends Chunk {

View File

@ -22,9 +22,7 @@ import com.google.android.exoplayer2.upstream.DataSource;
import com.google.android.exoplayer2.upstream.DataSpec; import com.google.android.exoplayer2.upstream.DataSpec;
import com.google.android.exoplayer2.util.Assertions; import com.google.android.exoplayer2.util.Assertions;
/** /** An abstract base class for {@link Chunk}s that contain media samples. */
* An abstract base class for {@link Chunk}s that contain media samples.
*/
public abstract class MediaChunk extends Chunk { public abstract class MediaChunk extends Chunk {
/** The chunk index, or {@link C#INDEX_UNSET} if it is not known. */ /** The chunk index, or {@link C#INDEX_UNSET} if it is not known. */

View File

@ -21,12 +21,10 @@ import com.google.android.exoplayer2.decoder.SimpleDecoder;
import com.google.android.exoplayer2.util.Assertions; import com.google.android.exoplayer2.util.Assertions;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
/** /** Base class for subtitle parsers that use their own decode thread. */
* Base class for subtitle parsers that use their own decode thread. public abstract class SimpleSubtitleDecoder
*/ extends SimpleDecoder<SubtitleInputBuffer, SubtitleOutputBuffer, SubtitleDecoderException>
public abstract class SimpleSubtitleDecoder extends implements SubtitleDecoder {
SimpleDecoder<SubtitleInputBuffer, SubtitleOutputBuffer, SubtitleDecoderException> implements
SubtitleDecoder {
private final String name; private final String name;

View File

@ -21,9 +21,7 @@ import com.google.android.exoplayer2.decoder.OutputBuffer;
import com.google.android.exoplayer2.util.Assertions; import com.google.android.exoplayer2.util.Assertions;
import java.util.List; import java.util.List;
/** /** Base class for {@link SubtitleDecoder} output buffers. */
* Base class for {@link SubtitleDecoder} output buffers.
*/
public abstract class SubtitleOutputBuffer extends OutputBuffer implements Subtitle { public abstract class SubtitleOutputBuffer extends OutputBuffer implements Subtitle {
@Nullable private Subtitle subtitle; @Nullable private Subtitle subtitle;

View File

@ -26,9 +26,7 @@ import com.google.android.exoplayer2.source.dash.manifest.SegmentBase.SingleSegm
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
/** /** A DASH representation. */
* A DASH representation.
*/
public abstract class Representation { public abstract class Representation {
/** /**

View File

@ -29,9 +29,7 @@ import java.math.BigInteger;
import java.math.RoundingMode; import java.math.RoundingMode;
import java.util.List; import java.util.List;
/** /** An approximate representation of a SegmentBase manifest element. */
* An approximate representation of a SegmentBase manifest element.
*/
public abstract class SegmentBase { public abstract class SegmentBase {
@Nullable /* package */ final RangedUri initialization; @Nullable /* package */ final RangedUri initialization;