Fix javadoc links in media README files

Also fixed the javadoc link in devsite and removed javadoc links from decoder extensions as it is not published yet on developer.android.com. #minor-release PiperOrigin-RevId: 520636868
androidx · Mar 30, 2023 · 6a92880 · 6a92880
1 parent cb578fc
commit 6a92880
Show file tree

Hide file tree

Showing 26 changed files with 26 additions and 51 deletions.
diff --git a/libraries/cast/README.md b/libraries/cast/README.md
@@ -32,4 +32,4 @@ UI module.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/cast/package-summary
diff --git a/libraries/common/README.md b/libraries/common/README.md
@@ -7,4 +7,4 @@ will not normally need to depend on this module directly.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/common/package-summary
diff --git a/libraries/database/README.md b/libraries/database/README.md
@@ -7,4 +7,4 @@ will not normally need to depend on this module directly.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/database/package-summary
diff --git a/libraries/datasource/README.md b/libraries/datasource/README.md
@@ -8,4 +8,4 @@ depend on this module directly.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/package-summary
diff --git a/libraries/datasource_cronet/README.md b/libraries/datasource_cronet/README.md
@@ -124,4 +124,4 @@ application.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/cronet/package-summary
diff --git a/libraries/datasource_okhttp/README.md b/libraries/datasource_okhttp/README.md
@@ -53,4 +53,4 @@ new DefaultDataSourceFactory(
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/okhttp/package-summary
diff --git a/libraries/datasource_rtmp/README.md b/libraries/datasource_rtmp/README.md
@@ -50,4 +50,4 @@ doesn't need to handle any other protocols, you can update any
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/datasource/rtmp/package-summary
diff --git a/libraries/decoder/README.md b/libraries/decoder/README.md
@@ -7,4 +7,4 @@ depend on this module directly.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/decoder/package-summary
diff --git a/libraries/decoder_av1/README.md b/libraries/decoder_av1/README.md
@@ -124,10 +124,5 @@ gets from the libgav1 decoder:
 Note: Although the default option uses `ANativeWindow`, based on our testing the
 GL rendering mode has better performance, so should be preferred
 
-## Links
-
 <!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
-
-*   [Javadoc][]
-
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+<!-- TODO(b/276289331): Add Javadoc link when it's published on developer.android.com -->
diff --git a/libraries/decoder_ffmpeg/README.md b/libraries/decoder_ffmpeg/README.md
@@ -117,10 +117,5 @@ then implement your own logic to use the renderer for a given track.
 [ExoPlayer issue 2781]: https://github.com/google/ExoPlayer/issues/2781
 [Supported formats]: https://developer.android.com/guide/topics/media/exoplayer/supported-formats#ffmpeg-library
 
-## Links
-
 <!-- TODO(b/204738828): Add link to 'troubleshooting using extensions' media3 guide entry when it's published on developer.android.com -->
-
-*   [Javadoc][]
-
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+<!-- TODO(b/276289331): Add Javadoc link when it's published on developer.android.com -->
diff --git a/libraries/decoder_flac/README.md b/libraries/decoder_flac/README.md
@@ -96,10 +96,5 @@ a custom track selector the choice of `Renderer` is up to your implementation,
 so you need to make sure you are passing an `LibflacAudioRenderer` to the
 player, then implement your own logic to use the renderer for a given track.
 
-## Links
-
 <!-- TODO(b/204738828): Add link to 'troubleshooting decoding using extensions' media3 guide entry when it's published on developer.android.com -->
-
-*   [Javadoc][]
-
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+<!-- TODO(b/276289331): Add Javadoc link when it's published on developer.android.com -->
diff --git a/libraries/decoder_opus/README.md b/libraries/decoder_opus/README.md
@@ -100,10 +100,5 @@ a custom track selector the choice of `Renderer` is up to your implementation,
 so you need to make sure you are passing an `LibopusAudioRenderer` to the
 player, then implement your own logic to use the renderer for a given track.
 
-## Links
-
 <!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
-
-*   [Javadoc][]
-
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+<!-- TODO(b/276289331): Add Javadoc link when it's published on developer.android.com -->
diff --git a/libraries/decoder_vp9/README.md b/libraries/decoder_vp9/README.md
@@ -137,10 +137,5 @@ gets from the libvpx decoder:
 Note: Although the default option uses `ANativeWindow`, based on our testing the
 GL rendering mode has better performance, so should be preferred.
 
-## Links
-
 <!-- TODO(b/204738828): Add link to 'troubleshooting using decoding extensions' media3 guide entry when it's published on developer.android.com -->
-
-*   [Javadoc][]
-
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+<!-- TODO(b/276289331): Add Javadoc link when it's published on developer.android.com -->
diff --git a/libraries/effect/README.md b/libraries/effect/README.md
@@ -22,4 +22,4 @@ locally. Instructions for doing this can be found in the [top level README][].
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/effect/package-summary
diff --git a/libraries/exoplayer/README.md b/libraries/exoplayer/README.md
@@ -23,4 +23,4 @@ locally. Instructions for doing this can be found in the [top level README][].
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/package-summary
diff --git a/libraries/exoplayer_dash/README.md b/libraries/exoplayer_dash/README.md
@@ -40,4 +40,4 @@ instances and pass them directly to the player. For advanced download use cases,
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/dash/package-summary
diff --git a/libraries/exoplayer_hls/README.md b/libraries/exoplayer_hls/README.md
@@ -39,4 +39,4 @@ instances and pass them directly to the player. For advanced download use cases,
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/hls/package-summary
diff --git a/libraries/exoplayer_ima/README.md b/libraries/exoplayer_ima/README.md
@@ -56,4 +56,4 @@ player position when backgrounded during ad playback.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/ima/package-summary
diff --git a/libraries/exoplayer_rtsp/README.md b/libraries/exoplayer_rtsp/README.md
@@ -34,4 +34,4 @@ instances and pass them directly to the player.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/rtsp/package-summary
diff --git a/libraries/exoplayer_smoothstreaming/README.md b/libraries/exoplayer_smoothstreaming/README.md
@@ -39,4 +39,4 @@ instances and pass them directly to the player. For advanced download use cases,
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/smoothstreaming/package-summary
diff --git a/libraries/exoplayer_workmanager/README.md b/libraries/exoplayer_workmanager/README.md
@@ -24,4 +24,4 @@ locally. Instructions for doing this can be found in the [top level README][].
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/exoplayer/workmanager/package-summary
diff --git a/libraries/extractor/README.md b/libraries/extractor/README.md
@@ -7,4 +7,4 @@ not normally need to depend on this module directly.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/extractor/package-summary
diff --git a/libraries/test_utils/README.md b/libraries/test_utils/README.md
@@ -6,4 +6,4 @@ Provides utility classes for media unit and instrumentation tests.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/test/utils/package-summary
diff --git a/libraries/test_utils_robolectric/README.md b/libraries/test_utils_robolectric/README.md
@@ -6,4 +6,4 @@ Provides test infrastructure for Robolectric-based media tests.
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/test/utils/robolectric/package-summary
diff --git a/libraries/transformer/README.md b/libraries/transformer/README.md
@@ -24,4 +24,4 @@ locally. Instructions for doing this can be found in the [top level README][].
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/transformer/package-summary
diff --git a/libraries/ui/README.md b/libraries/ui/README.md
@@ -24,4 +24,4 @@ locally. Instructions for doing this can be found in the [top level README][].
 
 *   [Javadoc][]
 
-[Javadoc]: https://developer.android.com/reference/androidx/media3/packages
+[Javadoc]: https://developer.android.com/reference/androidx/media3/ui/package-summary