Skip to content

Commit

Permalink
Tidy READMEs
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 405598530
  • Loading branch information
andrewlewis authored and ojw28 committed Oct 26, 2021
1 parent 0da494c commit 0ad1cdb
Show file tree
Hide file tree
Showing 25 changed files with 32 additions and 55 deletions.
3 changes: 1 addition & 2 deletions extensions/av1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 2 additions & 3 deletions extensions/cast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
3 changes: 1 addition & 2 deletions extensions/cronet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/ffmpeg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/flac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 2 additions & 3 deletions extensions/ima/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/leanback/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/okhttp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/opus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/rtmp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/vp9/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions extensions/workmanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion library/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion library/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 2 additions & 3 deletions library/dash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions library/datasource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions library/decoder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions library/extractor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 2 additions & 3 deletions library/hls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 2 additions & 3 deletions library/rtsp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 2 additions & 4 deletions library/smoothstreaming/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions library/transformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions library/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions robolectricutils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions testutils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 0ad1cdb

Please sign in to comment.