summaryrefslogtreecommitdiffstats
path: root/media/java
diff options
context:
space:
mode:
authorRyan Lothian <rjlothian@google.com>2014-11-26 18:04:45 +0000
committerLajos Molnar <lajos@google.com>2014-11-26 18:49:01 +0000
commit1e88cf0796c8b15952b7d6b3160d0d097e857f15 (patch)
tree55216b9826a91826bd69b7d7e57a98202bea3192 /media/java
parentf17f04a51e1e0b7f16d7c53015d0a66059b80cd3 (diff)
downloadframeworks_base-1e88cf0796c8b15952b7d6b3160d0d097e857f15.zip
frameworks_base-1e88cf0796c8b15952b7d6b3160d0d097e857f15.tar.gz
frameworks_base-1e88cf0796c8b15952b7d6b3160d0d097e857f15.tar.bz2
Fix broken @see javadoc in android.media.* classes
This CL fixes all android.media.* javadoc that includes an "ERROR(...)" message when rendered to HTML. Bug: 18537403 Change-Id: Ic60f7cfe4cf4961da163d955387d65a5d2011905 (cherry picked from commit d550f9028ee7f52018fbed3cfd2d0b18d6a7c4f0)
Diffstat (limited to 'media/java')
-rw-r--r--media/java/android/media/MediaFormat.java6
-rw-r--r--media/java/android/media/MediaPlayer.java12
-rw-r--r--media/java/android/media/MediaScannerConnection.java2
-rw-r--r--media/java/android/media/projection/MediaProjection.java3
4 files changed, 11 insertions, 12 deletions
diff --git a/media/java/android/media/MediaFormat.java b/media/java/android/media/MediaFormat.java
index 2036533..8faa75c 100644
--- a/media/java/android/media/MediaFormat.java
+++ b/media/java/android/media/MediaFormat.java
@@ -398,7 +398,7 @@ public final class MediaFormat {
* The associated value is an integer. These values are device and codec specific,
* but lower values generally result in faster and/or less power-hungry encoding.
*
- * @see MediaCodecInfo.CodecCapabilities.EncoderCapabilities#getComplexityRange
+ * @see MediaCodecInfo.EncoderCapabilities#getComplexityRange()
*/
public static final String KEY_COMPLEXITY = "complexity";
@@ -411,7 +411,7 @@ public final class MediaFormat {
*
* @hide
*
- * @see MediaCodecInfo.CodecCapabilities.EncoderCapabilities#getQualityRange
+ * @see MediaCodecInfo.EncoderCapabilities#getQualityRange()
*/
public static final String KEY_QUALITY = "quality";
@@ -428,7 +428,7 @@ public final class MediaFormat {
* A key describing the desired bitrate mode to be used by an encoder.
* Constants are declared in {@link MediaCodecInfo.CodecCapabilities}.
*
- * @see MediaCodecInfo.CodecCapabilities.EncoderCapabilities#isBitrateModeSupported
+ * @see MediaCodecInfo.EncoderCapabilities#isBitrateModeSupported(int)
*/
public static final String KEY_BITRATE_MODE = "bitrate-mode";
diff --git a/media/java/android/media/MediaPlayer.java b/media/java/android/media/MediaPlayer.java
index 91b1018..acf1b43 100644
--- a/media/java/android/media/MediaPlayer.java
+++ b/media/java/android/media/MediaPlayer.java
@@ -1640,7 +1640,7 @@ public class MediaPlayer implements SubtitleController.Listener
* Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation
* effect which can be applied on any sound source that directs a certain amount of its
* energy to this effect. This amount is defined by setAuxEffectSendLevel().
- * {@see #setAuxEffectSendLevel(float)}.
+ * See {@link #setAuxEffectSendLevel(float)}.
* <p>After creating an auxiliary effect (e.g.
* {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with
* {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method
@@ -1654,8 +1654,8 @@ public class MediaPlayer implements SubtitleController.Listener
/**
- * Sets the send level of the player to the attached auxiliary effect
- * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0.
+ * Sets the send level of the player to the attached auxiliary effect.
+ * See {@link #attachAuxEffect(int)}. The level value range is 0 to 1.0.
* <p>By default the send level is 0, so even if an effect is attached to the player
* this method must be called for the effect to be applied.
* <p>Note that the passed level value is a raw scalar. UI controls should be scaled
@@ -2283,9 +2283,9 @@ public class MediaPlayer implements SubtitleController.Listener
* when {@code trackType} is not one of audio, video, or subtitle.
* @throws IllegalStateException if called after {@link #release()}
*
- * @see {@link #getTrackInfo()}
- * @see {@link #selectTrack(int)}
- * @see {@link #deselectTrack(int)}
+ * @see #getTrackInfo()
+ * @see #selectTrack(int)
+ * @see #deselectTrack(int)
*/
public int getSelectedTrack(int trackType) throws IllegalStateException {
if (trackType == TrackInfo.MEDIA_TRACK_TYPE_SUBTITLE && mSubtitleController != null) {
diff --git a/media/java/android/media/MediaScannerConnection.java b/media/java/android/media/MediaScannerConnection.java
index 273eb64..d714672 100644
--- a/media/java/android/media/MediaScannerConnection.java
+++ b/media/java/android/media/MediaScannerConnection.java
@@ -228,7 +228,7 @@ public class MediaScannerConnection implements ServiceConnection {
* @param callback Optional callback through which you can receive the
* scanned URI and MIME type; If null, the file will be scanned but
* you will not get a result back.
- * @see scanFile(String, String)
+ * @see #scanFile(String, String)
*/
public static void scanFile(Context context, String[] paths, String[] mimeTypes,
OnScanCompletedListener callback) {
diff --git a/media/java/android/media/projection/MediaProjection.java b/media/java/android/media/projection/MediaProjection.java
index e6dadf9..2ca9b9a 100644
--- a/media/java/android/media/projection/MediaProjection.java
+++ b/media/java/android/media/projection/MediaProjection.java
@@ -126,8 +126,7 @@ public final class MediaProjection {
* invoked, or null if the callback should be invoked on the calling
* thread's main {@link android.os.Looper}.
*
- * @see android.hardware.display.DisplayManager#createVirtualDisplay(
- * String, int, int, int, int, Surface, VirtualDisplay.Callback, Handler)
+ * @see android.hardware.display.VirtualDisplay
*/
public VirtualDisplay createVirtualDisplay(@NonNull String name,
int width, int height, int dpi, int flags, @Nullable Surface surface,