Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 84d6d75d authored by Anton Hansson's avatar Anton Hansson
Browse files

Fix broken documentation in telephony and telecomm 

Due to a bug in the build system, broken @see/@link references have not
failed to build for a while, so many errors have accumulated.

This is an attempt to patch up the telephony and telecomm docs. The
most common errors and fixes were:
- @link-ing IntDef constants from javadoc. IntDefs are not present
  in the docs, so rewrite those to natural english, or point to the
  constant prefixes
- Javadoc for public symbols referencing SystemApi symbols. Change those
  to @code instead of @link

There were various other fixes too, and I'm not sure they're all
perfect, but certainly an improvement over the brokenness we have
currently.

Bug: 303184203
Test: m docs
Change-Id: I5cefc72074ced29c0b046cf59deb7ee371e74bf0
parent 7e491b25

api/javadoc-lint-baseline

+0 −36
Original line number Original line Diff line number Diff line
@@ -226,40 +226,6 @@ android/service/notification/NotificationListenerService.java:1155: lint: Unreso 
android/service/notification/NotificationListenerService.java:1166: lint: Unresolved link/see tag "android.service.notification.NotificationAssistantService NotificationAssistantService" in android.service.notification.NotificationListenerService.Ranking [101]

android/service/notification/NotificationListenerService.java:1166: lint: Unresolved link/see tag "android.service.notification.NotificationAssistantService NotificationAssistantService" in android.service.notification.NotificationListenerService.Ranking [101]

android/service/quickaccesswallet/WalletCard.java:285: lint: Unresolved link/see tag "PackageManager.FEATURE_WALLET_LOCATION_BASED_SUGGESTIONS" in android.service.quickaccesswallet.WalletCard.Builder [101]

android/service/quickaccesswallet/WalletCard.java:285: lint: Unresolved link/see tag "PackageManager.FEATURE_WALLET_LOCATION_BASED_SUGGESTIONS" in android.service.quickaccesswallet.WalletCard.Builder [101]

android/service/voice/VoiceInteractionSession.java:293: lint: Unresolved link/see tag "android.service.voice.VoiceInteractionService#KEY_SHOW_SESSION_ID VoiceInteractionService#KEY_SHOW_SESSION_ID" in android.service.voice.VoiceInteractionSession [101]

android/service/voice/VoiceInteractionSession.java:293: lint: Unresolved link/see tag "android.service.voice.VoiceInteractionService#KEY_SHOW_SESSION_ID VoiceInteractionService#KEY_SHOW_SESSION_ID" in android.service.voice.VoiceInteractionSession [101]

android/telecom/Call.java:94: lint: unable to parse link/see tag: #playDtmfTone(char [101]

android/telecom/CallControl.java:163: lint: Unresolved link/see tag "android.telecom.CallStreamingService CallStreamingService" in android.telecom.CallControl [101]

android/telecom/CallControlCallback.java:63: lint: Unresolved link/see tag "android.telecom.CallAttributes.CallType" in android.telecom.CallControlCallback [101]

android/telecom/PhoneAccountSuggestion.java:17: lint: Unresolved link/see tag "android.telecom.PhoneAccountSuggestionService PhoneAccountSuggestionService" in android.telecom.PhoneAccountSuggestion [101]

android/telephony/CarrierConfigManager.java:2934: lint: Unresolved link/see tag "android.telephony.TelephonyManager.PremiumCapability TelephonyManager.PremiumCapability" in android.telephony.CarrierConfigManager [101]

android/telephony/CarrierConfigManager.java:4020: lint: Unresolved link/see tag "ImsRegistrationImplBase.ImsRegistrationTech" in android.telephony.CarrierConfigManager.Ims [101]

android/telephony/CarrierConfigManager.java:4108: lint: Unresolved link/see tag "ImsRegistrationImplBase.ImsRegistrationTech" in android.telephony.CarrierConfigManager.Ims [101]

android/telephony/CarrierConfigManager.java:3920: lint: Unresolved link/see tag "android.telephony.ims.SipDelegateManager" in android.telephony.CarrierConfigManager.Ims [101]

android/telephony/CarrierConfigManager.java:4001: lint: Unresolved link/see tag "ImsRegistrationImplBase.ImsRegistrationTech" in android.telephony.CarrierConfigManager.Ims [101]

android/telephony/CarrierConfigManager.java:4089: lint: Unresolved link/see tag "ImsRegistrationImplBase.ImsRegistrationTech" in android.telephony.CarrierConfigManager.Ims [101]

android/telephony/NetworkRegistrationInfo.java:131: lint: Unresolved link/see tag "android.telephony.Annotation.NetworkType NetworkType" in android.telephony.NetworkRegistrationInfo [101]

android/telephony/PhoneStateListener.java:293: lint: Unresolved link/see tag "android.telephony.PreciseDisconnectCause PreciseDisconnectCause" in android.telephony.PhoneStateListener [101]

android/telephony/PhoneStateListener.java:544: lint: Unresolved link/see tag "android.telephony.PreciseDisconnectCause PreciseDisconnectCause" in android.telephony.PhoneStateListener [101]

android/telephony/SubscriptionManager.java:1385: lint: Unresolved link/see tag "Build.VERSION_CODES.P" in android.telephony.SubscriptionManager.OnSubscriptionsChangedListener [101]

android/telephony/SubscriptionManager.java:1385: lint: Unresolved link/see tag "Build.VERSION_CODES.V" in android.telephony.SubscriptionManager.OnSubscriptionsChangedListener [101]

android/telephony/SubscriptionPlan.java:134: lint: Unresolved link/see tag "android.telephony.Annotation.NetworkType NetworkType" in android.telephony.SubscriptionPlan [101]

android/telephony/SubscriptionPlan.java:288: lint: Unresolved link/see tag "android.telephony.Annotation.NetworkType NetworkType" in android.telephony.SubscriptionPlan.Builder [101]

android/telephony/TelephonyCallback.java:113: lint: Unresolved link/see tag "android.telephony.PreciseDisconnectCause PreciseDisconnectCause" in android.telephony.TelephonyCallback.CallDisconnectCauseListener [101]

android/telephony/TelephonyManager.java:2544: lint: Unresolved link/see tag "android.telephony.TelephonyManager.CarrierRestrictionStatus CarrierRestrictionStatus" in android.telephony.TelephonyManager [101]

android/telephony/TelephonyManager.java:2841: lint: Unresolved link/see tag "android.telephony.TelephonyManager.SetOpportunisticSubscriptionResult TelephonyManager.SetOpportunisticSubscriptionResult" in android.telephony.TelephonyManager [101]

android/telephony/TelephonyManager.java:3273: lint: Unresolved link/see tag "android.telephony.TelephonyManager.PurchasePremiumCapabilityResult PurchasePremiumCapabilityResult" in android.telephony.TelephonyManager [101]

android/telephony/TelephonyManager.java:3989: lint: Unresolved link/see tag "android.telephony.TelephonyManager.MobileDataPolicy MobileDataPolicy" in android.telephony.TelephonyManager [101]

android/telephony/data/ApnSetting.java:39: lint: Unresolved link/see tag "android.telephony.data.DataCallResponse#getMtuV4() DataCallResponse#getMtuV4()" in android.telephony.data.ApnSetting [101]

android/telephony/data/ApnSetting.java:50: lint: Unresolved link/see tag "android.telephony.data.DataCallResponse#getMtuV6() DataCallResponse#getMtuV6()" in android.telephony.data.ApnSetting [101]

android/telephony/data/ApnSetting.java:597: lint: Unresolved link/see tag "android.telephony.data.DataCallResponse#getMtuV4() DataCallResponse#getMtuV4()" in android.telephony.data.ApnSetting.Builder [101]

android/telephony/data/ApnSetting.java:611: lint: Unresolved link/see tag "android.telephony.data.DataCallResponse#getMtuV6() DataCallResponse#getMtuV6()" in android.telephony.data.ApnSetting.Builder [101]

android/telephony/euicc/EuiccManager.java:331: lint: Unresolved link/see tag "android.service.euicc.EuiccService#ACTION_BIND_CARRIER_PROVISIONING_SERVICE" in android.telephony.euicc.EuiccManager [101]

android/telephony/ims/ImsMmTelManager.java:117: lint: Unresolved link/see tag "android.telephony.ims.ImsService ImsService" in android.telephony.ims.ImsMmTelManager [101]

android/telephony/ims/ImsRcsManager.java:43: lint: Unresolved link/see tag "android.telephony.ims.ImsService ImsService" in android.telephony.ims.ImsRcsManager [101]

android/telephony/ims/ProvisioningManager.java:102: lint: Unresolved link/see tag "android.telephony.ims.feature.MmTelFeature.MmTelCapabilities.MmTelCapability MmTelFeature.MmTelCapabilities.MmTelCapability" in android.telephony.ims.ProvisioningManager [101]

android/telephony/ims/ProvisioningManager.java:102: lint: Unresolved link/see tag "android.telephony.ims.stub.ImsRegistrationImplBase.ImsRegistrationTech ImsRegistrationImplBase.ImsRegistrationTech" in android.telephony.ims.ProvisioningManager [101]

android/telephony/ims/ProvisioningManager.java:136: lint: Unresolved link/see tag "android.telephony.ims.ImsRcsManager.RcsImsCapabilityFlag ImsRcsManager.RcsImsCapabilityFlag" in android.telephony.ims.ProvisioningManager [101]

android/telephony/ims/RegistrationManager.java:21: lint: Unresolved link/see tag "android.telephony.ims.feature.ImsFeature ImsFeature" in android.telephony.ims.RegistrationManager [101]

android/telephony/ims/RegistrationManager.java:24: lint: Unresolved link/see tag "android.telephony.ims.ImsService ImsService" in android.telephony.ims.RegistrationManager [101]

android/text/DynamicLayout.java:141: lint: Unresolved link/see tag "LineBreakconfig" in android.text.DynamicLayout [101]

android/text/DynamicLayout.java:141: lint: Unresolved link/see tag "LineBreakconfig" in android.text.DynamicLayout [101]

android/text/WordSegmentFinder.java:13: lint: Unresolved link/see tag "android.text.method.WordIterator WordIterator" in android.text.WordSegmentFinder [101]

android/text/WordSegmentFinder.java:13: lint: Unresolved link/see tag "android.text.method.WordIterator WordIterator" in android.text.WordSegmentFinder [101]

android/view/InputDevice.java:71: lint: Unresolved link/see tag "InputManagerGlobal.InputDeviceListener" in android.view.InputDevice [101]

android/view/InputDevice.java:71: lint: Unresolved link/see tag "InputManagerGlobal.InputDeviceListener" in android.view.InputDevice [101]
@@ -370,7 +336,6 @@ android/service/voice/AlwaysOnHotwordDetector.java:269: lint: Unresolved link/se 
android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "#STATE_ERROR" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "#STATE_ERROR" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "Callback#onFailure" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "Callback#onFailure" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "Callback#onUnknownFailure" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "Callback#onUnknownFailure" in android [101]

android/telephony/TelephonyRegistryManager.java:242: lint: Unresolved link/see tag "#listenFromListener" in android [101]

android/view/animation/AnimationUtils.java:64: lint: Unresolved link/see tag "Build.VERSION_CODES#VANILLA_ICE_CREAM" in android.view.animation.AnimationUtils [101]

android/view/animation/AnimationUtils.java:64: lint: Unresolved link/see tag "Build.VERSION_CODES#VANILLA_ICE_CREAM" in android.view.animation.AnimationUtils [101]

android/view/contentcapture/ContentCaptureSession.java:188: lint: Unresolved link/see tag "UPSIDE_DOWN_CAKE" in android.view.contentcapture.ContentCaptureSession [101]

android/view/contentcapture/ContentCaptureSession.java:188: lint: Unresolved link/see tag "UPSIDE_DOWN_CAKE" in android.view.contentcapture.ContentCaptureSession [101]

com/android/internal/policy/PhoneWindow.java:172: lint: Unresolved link/see tag "Build.VERSION_CODES#VANILLA_ICE_CREAM" in com.android.internal.policy.PhoneWindow [101]

com/android/internal/policy/PhoneWindow.java:172: lint: Unresolved link/see tag "Build.VERSION_CODES#VANILLA_ICE_CREAM" in com.android.internal.policy.PhoneWindow [101]
@@ -393,7 +358,6 @@ com/android/server/pm/PackageInstallerSession.java:327: lint: Unresolved link/se 
com/android/server/pm/PackageInstallerSession.java:327: lint: Unresolved link/see tag "PackageInstaller.SessionParams#setRequestUpdateOwnership(boolean)" in android [101]

com/android/server/pm/PackageInstallerSession.java:327: lint: Unresolved link/see tag "PackageInstaller.SessionParams#setRequestUpdateOwnership(boolean)" in android [101]

com/android/server/pm/PackageInstallerSession.java:358: lint: Unresolved link/see tag "IntentSender" in android [101]

com/android/server/pm/PackageInstallerSession.java:358: lint: Unresolved link/see tag "IntentSender" in android [101]

com/android/server/devicepolicy/DevicePolicyManagerService.java:860: lint: Unresolved link/see tag "android.security.IKeyChainService#setGrant" in android [101]

com/android/server/devicepolicy/DevicePolicyManagerService.java:860: lint: Unresolved link/see tag "android.security.IKeyChainService#setGrant" in android [101]

android/telephony/SubscriptionManager.java:1370: lint: Unresolved link/see tag "Build.VERSION_CODES.Q" in android.telephony.SubscriptionManager.OnSubscriptionsChangedListener [101]





android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-4: lint: Invalid tag: @Override [131]

android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-4: lint: Invalid tag: @Override [131]

android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-1: lint: Invalid tag: @Override [131]

android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-1: lint: Invalid tag: @Override [131]

core/java/android/telephony/PhoneStateListener.java

+3 −3
Original line number Original line Diff line number Diff line
@@ -401,7 +401,7 @@ public class PhoneStateListener { 




    /**

    /**

     * Listen for call disconnect causes which contains {@link DisconnectCause} and

     * Listen for call disconnect causes which contains {@link DisconnectCause} and

     * {@link PreciseDisconnectCause}.

     * the precise disconnect cause.

     *

     *

     * <p>Requires permission {@link android.Manifest.permission#READ_PRECISE_PHONE_STATE}

     * <p>Requires permission {@link android.Manifest.permission#READ_PRECISE_PHONE_STATE}

     * or the calling app has carrier privileges

     * or the calling app has carrier privileges
@@ -851,8 +851,8 @@ public class PhoneStateListener { 
     * subId. Otherwise, this callback applies to

     * subId. Otherwise, this callback applies to

     * {@link SubscriptionManager#getDefaultSubscriptionId()}.

     * {@link SubscriptionManager#getDefaultSubscriptionId()}.

     *

     *

     * @param disconnectCause {@link DisconnectCause}.

     * @param disconnectCause the disconnect cause

     * @param preciseDisconnectCause {@link PreciseDisconnectCause}.

     * @param preciseDisconnectCause the precise disconnect cause

     * @deprecated Use {@link TelephonyCallback.CallDisconnectCauseListener} instead.

     * @deprecated Use {@link TelephonyCallback.CallDisconnectCauseListener} instead.

     */

     */

    @RequiresPermission(android.Manifest.permission.READ_PRECISE_PHONE_STATE)

    @RequiresPermission(android.Manifest.permission.READ_PRECISE_PHONE_STATE)

core/java/android/telephony/SubscriptionPlan.java

+2 −2
Original line number Original line Diff line number Diff line
@@ -221,7 +221,7 @@ public final class SubscriptionPlan implements Parcelable { 
    }

    }





    /**

    /**

     * Return an array containing all {@link NetworkType}s this SubscriptionPlan applies to.

     * Return an array containing all network types this SubscriptionPlan applies to.

     * @see TelephonyManager for network types values

     * @see TelephonyManager for network types values

     */

     */

    public @NonNull @NetworkType int[] getNetworkTypes() {

    public @NonNull @NetworkType int[] getNetworkTypes() {
@@ -365,7 +365,7 @@ public final class SubscriptionPlan implements Parcelable { 
         * Set the network types this SubscriptionPlan applies to. By default the plan will apply

         * Set the network types this SubscriptionPlan applies to. By default the plan will apply

         * to all network types. An empty array means this plan applies to no network types.

         * to all network types. An empty array means this plan applies to no network types.

         *

         *

         * @param networkTypes an array of all {@link NetworkType}s that apply to this plan.

         * @param networkTypes an array of all network types that apply to this plan.

         * @see TelephonyManager for network type values

         * @see TelephonyManager for network type values

         */

         */

        public @NonNull Builder setNetworkTypes(@NonNull @NetworkType int[] networkTypes) {

        public @NonNull Builder setNetworkTypes(@NonNull @NetworkType int[] networkTypes) {

core/java/android/telephony/TelephonyCallback.java

+2 −2
Original line number Original line Diff line number Diff line
@@ -948,8 +948,8 @@ public class TelephonyCallback { 
         * subscription ID. Otherwise, this callback applies to

         * subscription ID. Otherwise, this callback applies to

         * {@link SubscriptionManager#getDefaultSubscriptionId()}.

         * {@link SubscriptionManager#getDefaultSubscriptionId()}.

         *

         *

         * @param disconnectCause        {@link DisconnectCause}.

         * @param disconnectCause        the disconnect cause

         * @param preciseDisconnectCause {@link PreciseDisconnectCause}.

         * @param preciseDisconnectCause the precise disconnect cause

         */

         */

        @RequiresPermission(android.Manifest.permission.READ_PRECISE_PHONE_STATE)

        @RequiresPermission(android.Manifest.permission.READ_PRECISE_PHONE_STATE)

        void onCallDisconnectCauseChanged(@Annotation.DisconnectCauses int disconnectCause,

        void onCallDisconnectCauseChanged(@Annotation.DisconnectCauses int disconnectCause,

core/java/android/telephony/TelephonyRegistryManager.java

+1 −1
Original line number Original line Diff line number Diff line
@@ -238,7 +238,7 @@ public class TelephonyRegistryManager { 
    }

    }





    /**

    /**

     * To check the SDK version for {@link #listenFromListener}.

     * To check the SDK version for {@code #listenFromListener}.

     */

     */

    @ChangeId

    @ChangeId

    @EnabledAfter(targetSdkVersion = Build.VERSION_CODES.P)

    @EnabledAfter(targetSdkVersion = Build.VERSION_CODES.P)