From 0ad1cdbfa16b762c322d8f5bb4348f5b9d29e027 Mon Sep 17 00:00:00 2001 From: andrewlewis Date: Tue, 26 Oct 2021 10:30:55 +0100 Subject: [PATCH] Tidy READMEs PiperOrigin-RevId: 405598530 --- extensions/av1/README.md | 3 +-- extensions/cast/README.md | 5 ++--- extensions/cronet/README.md | 3 +-- extensions/ffmpeg/README.md | 3 +-- extensions/flac/README.md | 3 +-- extensions/ima/README.md | 5 ++--- extensions/leanback/README.md | 3 +-- extensions/okhttp/README.md | 3 +-- extensions/opus/README.md | 3 +-- extensions/rtmp/README.md | 3 +-- extensions/vp9/README.md | 3 +-- extensions/workmanager/README.md | 3 +-- library/common/README.md | 2 +- library/core/README.md | 2 +- library/dash/README.md | 5 ++--- library/datasource/README.md | 3 +-- library/decoder/README.md | 3 +-- library/extractor/README.md | 3 +-- library/hls/README.md | 5 ++--- library/rtsp/README.md | 5 ++--- library/smoothstreaming/README.md | 6 ++---- library/transformer/README.md | 3 +-- library/ui/README.md | 4 ++-- robolectricutils/README.md | 3 +-- testutils/README.md | 3 +-- 25 files changed, 32 insertions(+), 55 deletions(-) diff --git a/extensions/av1/README.md b/extensions/av1/README.md index c7b59baca2..f2a31dcbf1 100644 --- a/extensions/av1/README.md +++ b/extensions/av1/README.md @@ -135,7 +135,6 @@ GL rendering mode has better performance, so should be preferred ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.av1.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/cast/README.md b/extensions/cast/README.md index 880636f154..f09e1450e7 100644 --- a/extensions/cast/README.md +++ b/extensions/cast/README.md @@ -3,7 +3,7 @@ This module provides a [Player][] implementation that controls a Cast receiver app. -[Player]: https://exoplayer.dev/doc/reference/index.html?com/google/android/exoplayer2/Player.html +[Player]: https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/Player.html ## Getting the module @@ -30,7 +30,6 @@ UI module. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.cast.*` belong to this - module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/cronet/README.md b/extensions/cronet/README.md index 7749d27d6b..fc22a77d33 100644 --- a/extensions/cronet/README.md +++ b/extensions/cronet/README.md @@ -121,7 +121,6 @@ application. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.cronet.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/ffmpeg/README.md b/extensions/ffmpeg/README.md index cb0fdf3f7c..f4d596dc57 100644 --- a/extensions/ffmpeg/README.md +++ b/extensions/ffmpeg/README.md @@ -128,8 +128,7 @@ To try out playback using the module in the [demo application][], see ## Links * [Troubleshooting using extensions][] -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.ffmpeg.*` - belong to this module. +* [Javadoc][] [Troubleshooting using extensions]: https://exoplayer.dev/troubleshooting.html#how-can-i-get-a-decoding-extension-to-load-and-be-used-for-playback [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/flac/README.md b/extensions/flac/README.md index aaa4e35191..0614678f92 100644 --- a/extensions/flac/README.md +++ b/extensions/flac/README.md @@ -106,7 +106,6 @@ To try out playback using the module in the [demo application][], see ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.flac.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/ima/README.md b/extensions/ima/README.md index 335f4bf8c5..cb9015fd56 100644 --- a/extensions/ima/README.md +++ b/extensions/ima/README.md @@ -5,7 +5,7 @@ The ExoPlayer IMA module provides an [AdsLoader][] implementation wrapping the content played using ExoPlayer. [IMA]: https://developers.google.com/interactive-media-ads/docs/sdks/android/ -[AdsLoader]: https://exoplayer.dev/doc/reference/index.html?com/google/android/exoplayer2/source/ads/AdsLoader.html +[AdsLoader]: https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/source/ads/AdsLoader.html ## Getting the module @@ -53,8 +53,7 @@ player position when backgrounded during ad playback. ## Links * [ExoPlayer documentation on ad insertion][] -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.ima.*` - belong to this module. +* [Javadoc][] [ExoPlayer documentation on ad insertion]: https://exoplayer.dev/ad-insertion.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/leanback/README.md b/extensions/leanback/README.md index 19b1659c45..2f23762b97 100644 --- a/extensions/leanback/README.md +++ b/extensions/leanback/README.md @@ -25,7 +25,6 @@ locally. Instructions for doing this can be found in the [top level README][]. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.leanback.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/okhttp/README.md b/extensions/okhttp/README.md index 269b9a6100..020e3496c0 100644 --- a/extensions/okhttp/README.md +++ b/extensions/okhttp/README.md @@ -51,7 +51,6 @@ new DefaultDataSourceFactory( ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.okhttp.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/opus/README.md b/extensions/opus/README.md index e3242c3f32..e669344839 100644 --- a/extensions/opus/README.md +++ b/extensions/opus/README.md @@ -110,7 +110,6 @@ To try out playback using the module in the [demo application][], see ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.opus.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/rtmp/README.md b/extensions/rtmp/README.md index 3df7db9a56..f825b03367 100644 --- a/extensions/rtmp/README.md +++ b/extensions/rtmp/README.md @@ -48,7 +48,6 @@ doesn't need to handle any other protocols, you can update any ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.rtmp.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/vp9/README.md b/extensions/vp9/README.md index b24d089549..384064d68d 100644 --- a/extensions/vp9/README.md +++ b/extensions/vp9/README.md @@ -148,7 +148,6 @@ GL rendering mode has better performance, so should be preferred. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.vp9.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/extensions/workmanager/README.md b/extensions/workmanager/README.md index d69b47cae4..1cc28c7a37 100644 --- a/extensions/workmanager/README.md +++ b/extensions/workmanager/README.md @@ -22,7 +22,6 @@ locally. Instructions for doing this can be found in the [top level README][]. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ext.workmanager.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/common/README.md b/library/common/README.md index f2f8e2cca9..e9b59f7236 100644 --- a/library/common/README.md +++ b/library/common/README.md @@ -5,6 +5,6 @@ will not normally need to depend on this module directly. ## Links -* [Javadoc][]: Note that this Javadoc is combined with that of other modules. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/core/README.md b/library/core/README.md index a8c13c9e70..6eb4bad8b7 100644 --- a/library/core/README.md +++ b/library/core/README.md @@ -26,6 +26,6 @@ get started. ## Links -* [Javadoc][]: Note that this Javadoc is combined with that of other modules. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/dash/README.md b/library/dash/README.md index 0eb871a040..ea560e529a 100644 --- a/library/dash/README.md +++ b/library/dash/README.md @@ -36,9 +36,8 @@ instances and pass them directly to the player. For advanced download use cases, ## Links -* [Developer Guide][]. -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.source.dash.*` - belong to this module. +* [Developer Guide][] +* [Javadoc][] [Developer Guide]: https://exoplayer.dev/dash.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/datasource/README.md b/library/datasource/README.md index f87be557e9..ddd37c0e0d 100644 --- a/library/datasource/README.md +++ b/library/datasource/README.md @@ -6,7 +6,6 @@ depend on this module directly. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.upstream.*` belong to this - module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/decoder/README.md b/library/decoder/README.md index 7524b959d4..ef37e98884 100644 --- a/library/decoder/README.md +++ b/library/decoder/README.md @@ -5,7 +5,6 @@ depend on this module directly. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.decoder.*` belong to this - module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/extractor/README.md b/library/extractor/README.md index f7aaad1e4c..b1a08d9129 100644 --- a/library/extractor/README.md +++ b/library/extractor/README.md @@ -5,7 +5,6 @@ not normally need to depend on this module directly. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.extractor.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/hls/README.md b/library/hls/README.md index 93f776c25f..2168df1e80 100644 --- a/library/hls/README.md +++ b/library/hls/README.md @@ -35,9 +35,8 @@ instances and pass them directly to the player. For advanced download use cases, ## Links -* [Developer Guide][]. -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.source.hls.*` belong to - this module. +* [Developer Guide][] +* [Javadoc][] [Developer Guide]: https://exoplayer.dev/hls.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/rtsp/README.md b/library/rtsp/README.md index 08837189b0..c0a94bff5e 100644 --- a/library/rtsp/README.md +++ b/library/rtsp/README.md @@ -30,9 +30,8 @@ instances and pass them directly to the player. ## Links -* [Developer Guide][]. -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.source.rtsp.*` belong to - this module. +* [Developer Guide][] +* [Javadoc][] [Developer Guide]: https://exoplayer.dev/dash.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/smoothstreaming/README.md b/library/smoothstreaming/README.md index f187288666..1eceea29ef 100644 --- a/library/smoothstreaming/README.md +++ b/library/smoothstreaming/README.md @@ -35,10 +35,8 @@ instances and pass them directly to the player. For advanced download use cases, ## Links -* [Developer Guide][]. -* [Javadoc][]: Classes matching - `com.google.android.exoplayer2.source.smoothstreaming.*` belong to this - module. +* [Developer Guide][] +* [Javadoc][] [Developer Guide]: https://exoplayer.dev/smoothstreaming.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/transformer/README.md b/library/transformer/README.md index 0d7ba4f0d1..b9dc677531 100644 --- a/library/transformer/README.md +++ b/library/transformer/README.md @@ -25,7 +25,6 @@ Use of the Transformer module is documented in the ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.transformer.*` belong to this - module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/library/ui/README.md b/library/ui/README.md index b41072427a..8f1de86449 100644 --- a/library/ui/README.md +++ b/library/ui/README.md @@ -20,8 +20,8 @@ locally. Instructions for doing this can be found in the [top level README][]. ## Links -* [Developer Guide][]. -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.ui.*` belong to this module. +* [Developer Guide][] +* [Javadoc][] [Developer Guide]: https://exoplayer.dev/ui-components.html [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/robolectricutils/README.md b/robolectricutils/README.md index 84f9139c5c..a461d21940 100644 --- a/robolectricutils/README.md +++ b/robolectricutils/README.md @@ -4,7 +4,6 @@ Provides test infrastructure for Robolectric-based media tests. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.robolectric.*` - belong to this module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html diff --git a/testutils/README.md b/testutils/README.md index 9f7f924261..2830e7c640 100644 --- a/testutils/README.md +++ b/testutils/README.md @@ -4,7 +4,6 @@ Provides utility classes for media unit and instrumentation tests. ## Links -* [Javadoc][]: Classes matching `com.google.android.exoplayer2.testutil.*` belong to this - module. +* [Javadoc][] [Javadoc]: https://exoplayer.dev/doc/reference/index.html