Fix broken Javadoc

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=186999051
This commit is contained in:
olly 2018-02-26 03:49:15 -08:00 committed by Oliver Woodman
parent c4f82514bf
commit 0de6bb28a2
7 changed files with 38 additions and 41 deletions

View File

@ -39,18 +39,13 @@ public final class DrmInitData implements Comparator<SchemeData>, Parcelable {
* <p>The result is generated as follows. * <p>The result is generated as follows.
* *
* <ol> * <ol>
* <ol> * <li>Include all {@link SchemeData}s from {@code manifestData} where {@link
* Include all {@link SchemeData}s from {@code manifestData} where {@link * SchemeData#hasData()} is true.
* SchemeData#hasData()} is true. * <li>Include all {@link SchemeData}s in {@code mediaData} where {@link SchemeData#hasData()}
* </ol> * is true and for which we did not include an entry from the manifest targeting the same
* <ol> * UUID.
* Include all {@link SchemeData}s in {@code mediaData} where {@link SchemeData#hasData()} is * <li>If available, the scheme type from the manifest is used. If not, the scheme type from the
* true and for which we did not include an entry from the manifest targeting the same UUID. * media is used.
* </ol>
* <ol>
* If available, the scheme type from the manifest is used. If not, the scheme type from the
* media is used.
* </ol>
* </ol> * </ol>
* *
* @param manifestData DRM session acquisition data obtained from the manifest. * @param manifestData DRM session acquisition data obtained from the manifest.

View File

@ -43,7 +43,7 @@ public interface Clock {
* Creates a {@link HandlerWrapper} using a specified looper and a specified callback for handling * Creates a {@link HandlerWrapper} using a specified looper and a specified callback for handling
* messages. * messages.
* *
* @see Handler#Handler(Looper, Handler.Callback). * @see Handler#Handler(Looper, Handler.Callback)
*/ */
HandlerWrapper createHandler(Looper looper, @Nullable Handler.Callback callback); HandlerWrapper createHandler(Looper looper, @Nullable Handler.Callback callback);
} }

View File

@ -25,36 +25,36 @@ import android.os.Message;
*/ */
public interface HandlerWrapper { public interface HandlerWrapper {
/** @see Handler#getLooper(). */ /** @see Handler#getLooper() */
Looper getLooper(); Looper getLooper();
/** @see Handler#obtainMessage(int). */ /** @see Handler#obtainMessage(int) */
Message obtainMessage(int what); Message obtainMessage(int what);
/** @see Handler#obtainMessage(int, Object). */ /** @see Handler#obtainMessage(int, Object) */
Message obtainMessage(int what, Object obj); Message obtainMessage(int what, Object obj);
/** @see Handler#obtainMessage(int, int, int). */ /** @see Handler#obtainMessage(int, int, int) */
Message obtainMessage(int what, int arg1, int arg2); Message obtainMessage(int what, int arg1, int arg2);
/** @see Handler#obtainMessage(int, int, int, Object). */ /** @see Handler#obtainMessage(int, int, int, Object) */
Message obtainMessage(int what, int arg1, int arg2, Object obj); Message obtainMessage(int what, int arg1, int arg2, Object obj);
/** @see Handler#sendEmptyMessage(int). */ /** @see Handler#sendEmptyMessage(int) */
boolean sendEmptyMessage(int what); boolean sendEmptyMessage(int what);
/** @see Handler#sendEmptyMessageAtTime(int, long). */ /** @see Handler#sendEmptyMessageAtTime(int, long) */
boolean sendEmptyMessageAtTime(int what, long uptimeMs); boolean sendEmptyMessageAtTime(int what, long uptimeMs);
/** @see Handler#removeMessages(int). */ /** @see Handler#removeMessages(int) */
void removeMessages(int what); void removeMessages(int what);
/** @see Handler#removeCallbacksAndMessages(Object). */ /** @see Handler#removeCallbacksAndMessages(Object) */
void removeCallbacksAndMessages(Object token); void removeCallbacksAndMessages(Object token);
/** @see Handler#post(Runnable). */ /** @see Handler#post(Runnable) */
boolean post(Runnable runnable); boolean post(Runnable runnable);
/** @see Handler#postDelayed(Runnable, long). */ /** @see Handler#postDelayed(Runnable, long) */
boolean postDelayed(Runnable runnable, long delayMs); boolean postDelayed(Runnable runnable, long delayMs);
} }

View File

@ -942,7 +942,7 @@ public final class Util {
} }
/** /**
* Returns whether {@code encoding} is high resolution (> 16-bit) integer PCM. * Returns whether {@code encoding} is high resolution (&gt; 16-bit) integer PCM.
* *
* @param encoding The encoding of the audio data. * @param encoding The encoding of the audio data.
* @return Whether the encoding is high resolution integer PCM. * @return Whether the encoding is high resolution integer PCM.

View File

@ -732,19 +732,23 @@ public class DashManifestParser extends DefaultHandler
/** /**
* Parses a single Event node in the manifest. * Parses a single Event node in the manifest.
* <p> *
* @param xpp The current xml parser. * @param xpp The current xml parser.
* @param schemeIdUri The schemeIdUri of the parent EventStream. * @param schemeIdUri The schemeIdUri of the parent EventStream.
* @param value The schemeIdUri of the parent EventStream. * @param value The schemeIdUri of the parent EventStream.
* @param timescale The timescale of the parent EventStream. * @param timescale The timescale of the parent EventStream.
* @param scratchOutputStream A {@link ByteArrayOutputStream} that is used to write serialize data * @param scratchOutputStream A {@link ByteArrayOutputStream} that is used when parsing event
* in between <Event> and </Event> tags into. * objects.
* @return The {@link EventMessage} parsed from this EventStream node. * @return The {@link EventMessage} parsed from this EventStream node.
* @throws XmlPullParserException If there is any error parsing this node. * @throws XmlPullParserException If there is any error parsing this node.
* @throws IOException If there is any error reading from the underlying input stream. * @throws IOException If there is any error reading from the underlying input stream.
*/ */
protected EventMessage parseEvent(XmlPullParser xpp, String schemeIdUri, String value, protected EventMessage parseEvent(
long timescale, ByteArrayOutputStream scratchOutputStream) XmlPullParser xpp,
String schemeIdUri,
String value,
long timescale,
ByteArrayOutputStream scratchOutputStream)
throws IOException, XmlPullParserException { throws IOException, XmlPullParserException {
long id = parseLong(xpp, "id", 0); long id = parseLong(xpp, "id", 0);
long duration = parseLong(xpp, "duration", C.TIME_UNSET); long duration = parseLong(xpp, "duration", C.TIME_UNSET);
@ -757,11 +761,10 @@ public class DashManifestParser extends DefaultHandler
} }
/** /**
* Parses everything between <Event></Event> as a byte array string. * Parses an event object.
* *
* @param xpp The current xml parser. * @param xpp The current xml parser.
* @param scratchOutputStream A {@link ByteArrayOutputStream} that is used to write serialize byte * @param scratchOutputStream A {@link ByteArrayOutputStream} that's used when parsing the object.
* array data into.
* @return The serialized byte array. * @return The serialized byte array.
* @throws XmlPullParserException If there is any error parsing this node. * @throws XmlPullParserException If there is any error parsing this node.
* @throws IOException If there is any error reading from the underlying input stream. * @throws IOException If there is any error reading from the underlying input stream.

View File

@ -39,13 +39,12 @@ import java.util.List;
/** /**
* Helper class to download DASH streams. * Helper class to download DASH streams.
* *
* <p>Except {@link #getTotalSegments()}, {@link #getDownloadedSegments()} and * <p>Except {@link #getTotalSegments()}, {@link #getDownloadedSegments()} and {@link
* {@link #getDownloadedBytes()}, this class isn't thread safe. * #getDownloadedBytes()}, this class isn't thread safe.
* *
* <p>Example usage: * <p>Example usage:
* *
* <pre> * <pre>{@code
* {@code
* SimpleCache cache = new SimpleCache(downloadFolder, new NoOpCacheEvictor()); * SimpleCache cache = new SimpleCache(downloadFolder, new NoOpCacheEvictor());
* DefaultHttpDataSourceFactory factory = new DefaultHttpDataSourceFactory("ExoPlayer", null); * DefaultHttpDataSourceFactory factory = new DefaultHttpDataSourceFactory("ExoPlayer", null);
* DownloaderConstructorHelper constructorHelper = * DownloaderConstructorHelper constructorHelper =
@ -54,7 +53,7 @@ import java.util.List;
* // Select the first representation of the first adaptation set of the first period * // Select the first representation of the first adaptation set of the first period
* dashDownloader.selectRepresentations(new RepresentationKey[] {new RepresentationKey(0, 0, 0)}); * dashDownloader.selectRepresentations(new RepresentationKey[] {new RepresentationKey(0, 0, 0)});
* dashDownloader.download(new ProgressListener() { * dashDownloader.download(new ProgressListener() {
* @Override * {@literal @}Override
* public void onDownloadProgress(Downloader downloader, float downloadPercentage, * public void onDownloadProgress(Downloader downloader, float downloadPercentage,
* long downloadedBytes) { * long downloadedBytes) {
* // Invoked periodically during the download. * // Invoked periodically during the download.
@ -62,8 +61,8 @@ import java.util.List;
* }); * });
* // Access downloaded data using CacheDataSource * // Access downloaded data using CacheDataSource
* CacheDataSource cacheDataSource = * CacheDataSource cacheDataSource =
* new CacheDataSource(cache, factory.createDataSource(), CacheDataSource.FLAG_BLOCK_ON_CACHE);} * new CacheDataSource(cache, factory.createDataSource(), CacheDataSource.FLAG_BLOCK_ON_CACHE);
* </pre> * }</pre>
*/ */
public final class DashDownloader extends SegmentDownloader<DashManifest, RepresentationKey> { public final class DashDownloader extends SegmentDownloader<DashManifest, RepresentationKey> {

View File

@ -48,7 +48,7 @@ import java.util.List;
* // Select the first track of the first stream element * // Select the first track of the first stream element
* ssDownloader.selectRepresentations(new TrackKey[] {new TrackKey(0, 0)}); * ssDownloader.selectRepresentations(new TrackKey[] {new TrackKey(0, 0)});
* ssDownloader.download(new ProgressListener() { * ssDownloader.download(new ProgressListener() {
* @Override * {@literal @}Override
* public void onDownloadProgress(Downloader downloader, float downloadPercentage, * public void onDownloadProgress(Downloader downloader, float downloadPercentage,
* long downloadedBytes) { * long downloadedBytes) {
* // Invoked periodically during the download. * // Invoked periodically during the download.