From 26058898866fd706e1f6f07a0cc1a9227283fb1e Mon Sep 17 00:00:00 2001 From: Amy Zhang Date: Tue, 8 Dec 2020 12:11:10 -0800 Subject: [PATCH] Fix the Tuner Framework javadoc @link format Test: make services Bug: 175130122 Change-Id: I571f6dfeba1dbd7636273372a527ca2a4943e4e2 --- .../android/media/tv/tuner/Descrambler.java | 4 +-- media/java/android/media/tv/tuner/Tuner.java | 32 +++++++++---------- .../media/tv/tuner/filter/AvSettings.java | 8 ++--- .../android/media/tv/tuner/filter/Filter.java | 12 +++---- .../tv/tuner/filter/IpCidChangeEvent.java | 4 +-- .../tuner/filter/IpFilterConfiguration.java | 4 +-- .../tv/tuner/filter/MmtpRecordEvent.java | 16 +++++----- .../media/tv/tuner/filter/RestartEvent.java | 2 +- .../tuner/filter/ScramblingStatusEvent.java | 4 +-- .../media/tv/tuner/filter/TsRecordEvent.java | 8 ++--- .../frontend/AnalogFrontendSettings.java | 2 +- .../frontend/DtmbFrontendCapabilities.java | 21 ++++-------- .../tuner/frontend/DtmbFrontendSettings.java | 2 +- .../frontend/DvbcFrontendCapabilities.java | 6 ++-- .../tuner/frontend/DvbcFrontendSettings.java | 6 ++-- .../tuner/frontend/DvbsFrontendSettings.java | 6 ++-- .../tuner/frontend/DvbtFrontendSettings.java | 4 +-- .../media/tv/tuner/frontend/FrontendInfo.java | 2 +- .../tv/tuner/frontend/FrontendSettings.java | 4 +-- .../tv/tuner/frontend/FrontendStatus.java | 30 ++++++++--------- 20 files changed, 84 insertions(+), 93 deletions(-) diff --git a/media/java/android/media/tv/tuner/Descrambler.java b/media/java/android/media/tv/tuner/Descrambler.java index 700e7beb06c67..b64ba887e9cd5 100644 --- a/media/java/android/media/tv/tuner/Descrambler.java +++ b/media/java/android/media/tv/tuner/Descrambler.java @@ -117,9 +117,9 @@ public class Descrambler implements AutoCloseable { *

A descrambler instance can have only one key slot to link, but a key slot can hold a few * keys for different purposes. {@link Tuner.VOID_KEYTOKEN} is considered valid. * - * @param keyToken the token to be used to link the key slot. Use {@link Tuner.VOID_KEYTOKEN} + * @param keyToken the token to be used to link the key slot. Use {@link Tuner#VOID_KEYTOKEN} * to remove the current key from descrambler. If the current keyToken comes from a - * MediaCas session, use {@link Tuner.VOID_KEYTOKEN} to remove current key before + * MediaCas session, use {@link Tuner#VOID_KEYTOKEN} to remove current key before * closing the MediaCas session. * @return result status of the operation. */ diff --git a/media/java/android/media/tv/tuner/Tuner.java b/media/java/android/media/tv/tuner/Tuner.java index d094c2cd3c631..196348cd1c196 100644 --- a/media/java/android/media/tv/tuner/Tuner.java +++ b/media/java/android/media/tv/tuner/Tuner.java @@ -677,7 +677,7 @@ public class Tuner implements AutoCloseable { * *

Tuner resource manager (TRM) uses the client priority value to decide whether it is able * to get frontend resource. If the client can't get the resource, this call returns {@link - * Result#RESULT_UNAVAILABLE}. + * #RESULT_UNAVAILABLE}. * *

* This locks the frontend to a frequency by providing signal @@ -691,7 +691,7 @@ public class Tuner implements AutoCloseable { * *

Tuning with {@link android.media.tv.tuner.frontend.DtmbFrontendSettings} is only * supported in Tuner 1.1 or higher version. Unsupported version will cause no-op. Use {@link - * TunerVersionChecker.getTunerVersion()} to get the version information. + * TunerVersionChecker#getTunerVersion()} to get the version information. * * @param settings Signal delivery information the frontend uses to * search and lock the signal. @@ -740,7 +740,7 @@ public class Tuner implements AutoCloseable { * *

Scanning with {@link android.media.tv.tuner.frontend.DtmbFrontendSettings} is only * supported in Tuner 1.1 or higher version. Unsupported version will cause no-op. Use {@link - * TunerVersionChecker.getTunerVersion()} to get the version information. + * TunerVersionChecker#getTunerVersion()} to get the version information. * * @param settings A {@link FrontendSettings} to configure the frontend. * @param scanType The scan type. @@ -846,7 +846,7 @@ public class Tuner implements AutoCloseable { *

This retrieve the statuses of the frontend for given status types. * * @param statusTypes an array of status types which the caller requests. Any types that are not - * in {@link FrontendInfo.getStatusCapabilities()} would be ignored. + * in {@link FrontendInfo#getStatusCapabilities()} would be ignored. * @return statuses which response the caller's requests. {@code null} if the operation failed. */ @Nullable @@ -895,7 +895,7 @@ public class Tuner implements AutoCloseable { * use the output from CI-CAM as the input after this call. * *

Note that this API is used to connect the CI-CAM to the Demux module while - * {@link connectFrontendToCiCam(int)} is used to connect CI-CAM to the Frontend module. + * {@link #connectFrontendToCiCam(int)} is used to connect CI-CAM to the Frontend module. * * @param ciCamId specify CI-CAM Id to connect. * @return result status of the operation. @@ -917,20 +917,20 @@ public class Tuner implements AutoCloseable { * the TS directly from the frontend. * *

Note that this API is used to connect the CI-CAM to the Frontend module while - * {@link connectCiCam(int)} is used to connect CI-CAM to the Demux module. + * {@link #connectCiCam(int)} is used to connect CI-CAM to the Demux module. * *

Use {@link #disconnectFrontendToCiCam(int)} to disconnect. * *

This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause - * no-op and return {@link INVALID_LTS_ID}. Use {@link TunerVersionChecker.getTunerVersion()} to - * check the version. + * no-op and return {@link #INVALID_LTS_ID}. Use {@link TunerVersionChecker#getTunerVersion()} + * to check the version. * * @param ciCamId specify CI-CAM Id, which is the id of the Conditional Access Modules (CAM) * Common Interface (CI), to link. * @return Local transport stream id when connection is successfully established. Failed - * operation returns {@link INVALID_LTS_ID} while unsupported version also returns - * {@link INVALID_LTS_ID}. Check the current HAL version using - * {@link TunerVersionChecker.getTunerVersion()}. + * operation returns {@link #INVALID_LTS_ID} while unsupported version also returns + * {@link #INVALID_LTS_ID}. Check the current HAL version using + * {@link TunerVersionChecker#getTunerVersion()}. */ public int connectFrontendToCiCam(int ciCamId) { if (TunerVersionChecker.checkHigherOrEqualVersionTo(TunerVersionChecker.TUNER_VERSION_1_1, @@ -948,7 +948,7 @@ public class Tuner implements AutoCloseable { *

The demux will use the output from the frontend as the input after this call. * *

Note that this API is used to disconnect the CI-CAM to the Demux module while - * {@link disconnectFrontendToCiCam(int)} is used to disconnect CI-CAM to the Frontend module. + * {@link #disconnectFrontendToCiCam(int)} is used to disconnect CI-CAM to the Frontend module. * * @return result status of the operation. */ @@ -966,15 +966,15 @@ public class Tuner implements AutoCloseable { *

It is used by the client to unlink CI-CAM to a Frontend. * *

Note that this API is used to disconnect the CI-CAM to the Demux module while - * {@link disconnectCiCam(int)} is used to disconnect CI-CAM to the Frontend module. + * {@link #disconnectCiCam(int)} is used to disconnect CI-CAM to the Frontend module. * *

This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause - * no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version. + * no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version. * * @param ciCamId specify CI-CAM Id, which is the id of the Conditional Access Modules (CAM) * Common Interface (CI), to disconnect. * @return result status of the operation. Unsupported version would return - * {@link RESULT_UNAVAILABLE} + * {@link #RESULT_UNAVAILABLE} */ @Result public int disconnectFrontendToCiCam(int ciCamId) { @@ -1283,7 +1283,7 @@ public class Tuner implements AutoCloseable { /** * Opens a Descrambler in tuner. * - * @return a {@link Descrambler} object. + * @return a {@link Descrambler} object. */ @RequiresPermission(android.Manifest.permission.ACCESS_TV_DESCRAMBLER) @Nullable diff --git a/media/java/android/media/tv/tuner/filter/AvSettings.java b/media/java/android/media/tv/tuner/filter/AvSettings.java index e482875c38d3d..25457a7bd4378 100644 --- a/media/java/android/media/tv/tuner/filter/AvSettings.java +++ b/media/java/android/media/tv/tuner/filter/AvSettings.java @@ -251,9 +251,9 @@ public class AvSettings extends Settings { * Sets the Audio Stream Type. * *

This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause - * no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version. + * no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version. * - * @param audioStreamType the {@link AudioStreamType} to set. + * @param audioStreamType the audio stream type to set. */ @NonNull public Builder setAudioStreamType(@AudioStreamType int audioStreamType) { @@ -269,9 +269,9 @@ public class AvSettings extends Settings { * Sets the Video Stream Type. * *

This API is only supported by Tuner HAL 1.1 or higher. Unsupported version would cause - * no-op. Use {@link TunerVersionChecker.getTunerVersion()} to check the version. + * no-op. Use {@link TunerVersionChecker#getTunerVersion()} to check the version. * - * @param videoStreamType the {@link VideoStreamType} to set. + * @param videoStreamType the video stream type to set. */ @NonNull public Builder setVideoStreamType(@VideoStreamType int videoStreamType) { diff --git a/media/java/android/media/tv/tuner/filter/Filter.java b/media/java/android/media/tv/tuner/filter/Filter.java index 451f54caf7f96..96371e505a771 100644 --- a/media/java/android/media/tv/tuner/filter/Filter.java +++ b/media/java/android/media/tv/tuner/filter/Filter.java @@ -323,25 +323,25 @@ public class Filter implements AutoCloseable { } /** - * Configure the Filter to monitor scrambling status and ip cid change. Set corresponding bit of - * {@link MonitorEventTypeMask} to monitor the change. Reset to stop monitoring. + * Configure the Filter to monitor scrambling status and ip cid change. Set corresponding bit + * to monitor the change. Reset to stop monitoring. * *

{@link ScramblingStatusEvent} should be sent at the following two scenarios: *