Update @return to Returns where appropriate

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=129201483
This commit is contained in:
olly 2016-08-03 04:34:08 -07:00 committed by Oliver Woodman
parent 490c5fea78
commit e26f72d454
7 changed files with 13 additions and 19 deletions

View File

@ -140,7 +140,7 @@ import java.nio.ByteBuffer;
} }
/** /**
* @return The position of the next data to be decoded or -1 in case of error. * Returns the position of the next data to be decoded, or -1 in case of error.
*/ */
public long getDecodePosition() { public long getDecodePosition() {
return flacGetDecodePosition(nativeDecoderContext); return flacGetDecodePosition(nativeDecoderContext);

View File

@ -411,7 +411,7 @@ public final class Format implements Parcelable {
} }
/** /**
* @return A {@link MediaFormat} representation of this format. * Returns a {@link MediaFormat} representation of this format.
*/ */
@SuppressLint("InlinedApi") @SuppressLint("InlinedApi")
@TargetApi(16) @TargetApi(16)

View File

@ -232,40 +232,35 @@ public final class SimpleExoPlayer implements ExoPlayer {
} }
/** /**
* @return The video format currently being played, or null if there is no video component to the * Returns the video format currently being played, or null if no video is being played.
* current media.
*/ */
public Format getVideoFormat() { public Format getVideoFormat() {
return videoFormat; return videoFormat;
} }
/** /**
* @return The audio format currently being played, or null if there is no audio component to the * Returns the audio format currently being played, or null if no audio is being played.
* current media.
*/ */
public Format getAudioFormat() { public Format getAudioFormat() {
return audioFormat; return audioFormat;
} }
/** /**
* @return The audio session identifier. If not set {@code AudioTrack.SESSION_ID_NOT_SET} is * Returns the audio session identifier, or {@code AudioTrack.SESSION_ID_NOT_SET} if not set.
* returned.
*/ */
public int getAudioSessionId() { public int getAudioSessionId() {
return audioSessionId; return audioSessionId;
} }
/** /**
* @return The {@link DecoderCounters} for video, or null if there is no video component to the * Returns {@link DecoderCounters} for video, or null if no video is being played.
* current media.
*/ */
public DecoderCounters getVideoDecoderCounters() { public DecoderCounters getVideoDecoderCounters() {
return videoDecoderCounters; return videoDecoderCounters;
} }
/** /**
* @return The {@link DecoderCounters} for audio, or null if there is no audio component to the * Returns {@link DecoderCounters} for audio, or null if no audio is being played.
* current media.
*/ */
public DecoderCounters getAudioDecoderCounters() { public DecoderCounters getAudioDecoderCounters() {
return audioDecoderCounters; return audioDecoderCounters;

View File

@ -111,7 +111,7 @@ import java.io.IOException;
} }
/** /**
* @return A ParsableByteArray containing the payload of the packet. * Returns a {@link ParsableByteArray} containing the packet's payload.
*/ */
public ParsableByteArray getPayload() { public ParsableByteArray getPayload() {
return packetArray; return packetArray;

View File

@ -27,9 +27,8 @@ import java.io.IOException;
/* package */ interface OggSeeker { /* package */ interface OggSeeker {
/** /**
* @return a SeekMap instance which returns an initial estimated position for progressive seeking * Returns a {@link SeekMap} that returns an initial estimated position for progressive seeking
* or the final position for direct seeking. Returns null if {@link #read} hasn't returned -1 * or the final position for direct seeking. Returns null if {@link #read} has yet to return -1.
* yet.
*/ */
SeekMap createSeekMap(); SeekMap createSeekMap();

View File

@ -380,7 +380,7 @@ public final class MediaCodecUtil {
android.media.MediaCodecInfo getCodecInfoAt(int index); android.media.MediaCodecInfo getCodecInfoAt(int index);
/** /**
* @return Returns whether secure decoders are explicitly listed, if present. * Returns whether secure decoders are explicitly listed, if present.
*/ */
boolean secureDecodersExplicit(); boolean secureDecodersExplicit();

View File

@ -150,8 +150,8 @@ public final class FakeDataSource implements DataSource {
} }
/** /**
* @return The {@link DataSpec} instances passed to {@link #open(DataSpec)} since the last call * Returns the {@link DataSpec} instances passed to {@link #open(DataSpec)} since the last call to
* to this method. * this method.
*/ */
public DataSpec[] getAndClearOpenedDataSpecs() { public DataSpec[] getAndClearOpenedDataSpecs() {
DataSpec[] dataSpecs = new DataSpec[openedDataSpecs.size()]; DataSpec[] dataSpecs = new DataSpec[openedDataSpecs.size()];