From 0de6bb28a25d7730ddb47d16332b282becaa5209 Mon Sep 17 00:00:00 2001 From: olly Date: Mon, 26 Feb 2018 03:49:15 -0800 Subject: [PATCH] Fix broken Javadoc ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=186999051 --- .../android/exoplayer2/drm/DrmInitData.java | 19 ++++++---------- .../google/android/exoplayer2/util/Clock.java | 2 +- .../exoplayer2/util/HandlerWrapper.java | 22 +++++++++---------- .../google/android/exoplayer2/util/Util.java | 2 +- .../dash/manifest/DashManifestParser.java | 19 +++++++++------- .../source/dash/offline/DashDownloader.java | 13 +++++------ .../smoothstreaming/offline/SsDownloader.java | 2 +- 7 files changed, 38 insertions(+), 41 deletions(-) diff --git a/library/core/src/main/java/com/google/android/exoplayer2/drm/DrmInitData.java b/library/core/src/main/java/com/google/android/exoplayer2/drm/DrmInitData.java index 5662730650..4a59667dc8 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/drm/DrmInitData.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/drm/DrmInitData.java @@ -39,18 +39,13 @@ public final class DrmInitData implements Comparator, Parcelable { *

The result is generated as follows. * *

    - *
      - * Include all {@link SchemeData}s from {@code manifestData} where {@link - * SchemeData#hasData()} is true. - *
    - *
      - * Include all {@link SchemeData}s in {@code mediaData} where {@link SchemeData#hasData()} is - * true and for which we did not include an entry from the manifest targeting the same UUID. - *
    - *
      - * If available, the scheme type from the manifest is used. If not, the scheme type from the - * media is used. - *
    + *
  1. Include all {@link SchemeData}s from {@code manifestData} where {@link + * SchemeData#hasData()} is true. + *
  2. Include all {@link SchemeData}s in {@code mediaData} where {@link SchemeData#hasData()} + * is true and for which we did not include an entry from the manifest targeting the same + * UUID. + *
  3. If available, the scheme type from the manifest is used. If not, the scheme type from the + * media is used. *
* * @param manifestData DRM session acquisition data obtained from the manifest. diff --git a/library/core/src/main/java/com/google/android/exoplayer2/util/Clock.java b/library/core/src/main/java/com/google/android/exoplayer2/util/Clock.java index dced6752eb..36fc3b1bf8 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/util/Clock.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/util/Clock.java @@ -43,7 +43,7 @@ public interface Clock { * Creates a {@link HandlerWrapper} using a specified looper and a specified callback for handling * messages. * - * @see Handler#Handler(Looper, Handler.Callback). + * @see Handler#Handler(Looper, Handler.Callback) */ HandlerWrapper createHandler(Looper looper, @Nullable Handler.Callback callback); } diff --git a/library/core/src/main/java/com/google/android/exoplayer2/util/HandlerWrapper.java b/library/core/src/main/java/com/google/android/exoplayer2/util/HandlerWrapper.java index 3ce93f9370..8f1a6544ca 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/util/HandlerWrapper.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/util/HandlerWrapper.java @@ -25,36 +25,36 @@ import android.os.Message; */ public interface HandlerWrapper { - /** @see Handler#getLooper(). */ + /** @see Handler#getLooper() */ Looper getLooper(); - /** @see Handler#obtainMessage(int). */ + /** @see Handler#obtainMessage(int) */ Message obtainMessage(int what); - /** @see Handler#obtainMessage(int, Object). */ + /** @see Handler#obtainMessage(int, Object) */ 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); - /** @see Handler#obtainMessage(int, int, int, Object). */ + /** @see Handler#obtainMessage(int, int, int, Object) */ Message obtainMessage(int what, int arg1, int arg2, Object obj); - /** @see Handler#sendEmptyMessage(int). */ + /** @see Handler#sendEmptyMessage(int) */ boolean sendEmptyMessage(int what); - /** @see Handler#sendEmptyMessageAtTime(int, long). */ + /** @see Handler#sendEmptyMessageAtTime(int, long) */ boolean sendEmptyMessageAtTime(int what, long uptimeMs); - /** @see Handler#removeMessages(int). */ + /** @see Handler#removeMessages(int) */ void removeMessages(int what); - /** @see Handler#removeCallbacksAndMessages(Object). */ + /** @see Handler#removeCallbacksAndMessages(Object) */ void removeCallbacksAndMessages(Object token); - /** @see Handler#post(Runnable). */ + /** @see Handler#post(Runnable) */ boolean post(Runnable runnable); - /** @see Handler#postDelayed(Runnable, long). */ + /** @see Handler#postDelayed(Runnable, long) */ boolean postDelayed(Runnable runnable, long delayMs); } diff --git a/library/core/src/main/java/com/google/android/exoplayer2/util/Util.java b/library/core/src/main/java/com/google/android/exoplayer2/util/Util.java index cd643f2df4..2761cc3ce6 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/util/Util.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/util/Util.java @@ -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 (> 16-bit) integer PCM. * * @param encoding The encoding of the audio data. * @return Whether the encoding is high resolution integer PCM. diff --git a/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/manifest/DashManifestParser.java b/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/manifest/DashManifestParser.java index 1416e9beeb..2d3819c2ac 100644 --- a/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/manifest/DashManifestParser.java +++ b/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/manifest/DashManifestParser.java @@ -732,19 +732,23 @@ public class DashManifestParser extends DefaultHandler /** * Parses a single Event node in the manifest. - *

+ * * @param xpp The current xml parser. * @param schemeIdUri The schemeIdUri of the parent EventStream. * @param value The schemeIdUri of the parent EventStream. * @param timescale The timescale of the parent EventStream. - * @param scratchOutputStream A {@link ByteArrayOutputStream} that is used to write serialize data - * in between and tags into. + * @param scratchOutputStream A {@link ByteArrayOutputStream} that is used when parsing event + * objects. * @return The {@link EventMessage} parsed from this EventStream node. * @throws XmlPullParserException If there is any error parsing this node. * @throws IOException If there is any error reading from the underlying input stream. */ - protected EventMessage parseEvent(XmlPullParser xpp, String schemeIdUri, String value, - long timescale, ByteArrayOutputStream scratchOutputStream) + protected EventMessage parseEvent( + XmlPullParser xpp, + String schemeIdUri, + String value, + long timescale, + ByteArrayOutputStream scratchOutputStream) throws IOException, XmlPullParserException { long id = parseLong(xpp, "id", 0); long duration = parseLong(xpp, "duration", C.TIME_UNSET); @@ -757,11 +761,10 @@ public class DashManifestParser extends DefaultHandler } /** - * Parses everything between as a byte array string. + * Parses an event object. * * @param xpp The current xml parser. - * @param scratchOutputStream A {@link ByteArrayOutputStream} that is used to write serialize byte - * array data into. + * @param scratchOutputStream A {@link ByteArrayOutputStream} that's used when parsing the object. * @return The serialized byte array. * @throws XmlPullParserException If there is any error parsing this node. * @throws IOException If there is any error reading from the underlying input stream. diff --git a/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/offline/DashDownloader.java b/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/offline/DashDownloader.java index 2b2c37be3d..5c02fccad0 100644 --- a/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/offline/DashDownloader.java +++ b/library/dash/src/main/java/com/google/android/exoplayer2/source/dash/offline/DashDownloader.java @@ -39,13 +39,12 @@ import java.util.List; /** * Helper class to download DASH streams. * - *

Except {@link #getTotalSegments()}, {@link #getDownloadedSegments()} and - * {@link #getDownloadedBytes()}, this class isn't thread safe. + *

Except {@link #getTotalSegments()}, {@link #getDownloadedSegments()} and {@link + * #getDownloadedBytes()}, this class isn't thread safe. * *

Example usage: * - * 

- * {@code
+ * 
{@code
  * SimpleCache cache = new SimpleCache(downloadFolder, new NoOpCacheEvictor());
  * DefaultHttpDataSourceFactory factory = new DefaultHttpDataSourceFactory("ExoPlayer", null);
  * DownloaderConstructorHelper constructorHelper =
@@ -54,7 +53,7 @@ import java.util.List;
  * // Select the first representation of the first adaptation set of the first period
  * dashDownloader.selectRepresentations(new RepresentationKey[] {new RepresentationKey(0, 0, 0)});
  * dashDownloader.download(new ProgressListener() {
- *   @Override
+ *   {@literal @}Override
  *   public void onDownloadProgress(Downloader downloader, float downloadPercentage,
  *       long downloadedBytes) {
  *     // Invoked periodically during the download.
@@ -62,8 +61,8 @@ import java.util.List;
  * });
  * // Access downloaded data using CacheDataSource
  * CacheDataSource cacheDataSource =
- *     new CacheDataSource(cache, factory.createDataSource(), CacheDataSource.FLAG_BLOCK_ON_CACHE);}
- * 

+ *     new CacheDataSource(cache, factory.createDataSource(), CacheDataSource.FLAG_BLOCK_ON_CACHE);
+ * }
*/ public final class DashDownloader extends SegmentDownloader { diff --git a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/offline/SsDownloader.java b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/offline/SsDownloader.java index 12cfe2ee36..7988523bed 100644 --- a/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/offline/SsDownloader.java +++ b/library/smoothstreaming/src/main/java/com/google/android/exoplayer2/source/smoothstreaming/offline/SsDownloader.java @@ -48,7 +48,7 @@ import java.util.List; * // Select the first track of the first stream element * ssDownloader.selectRepresentations(new TrackKey[] {new TrackKey(0, 0)}); * ssDownloader.download(new ProgressListener() { - * @Override + * {@literal @}Override * public void onDownloadProgress(Downloader downloader, float downloadPercentage, * long downloadedBytes) { * // Invoked periodically during the download.