diff options
author | 2023-10-13 13:16:35 +0000 | |
---|---|---|
committer | 2023-10-13 18:32:05 +0000 | |
commit | 2ccbeb75aa89a7ff598230ad08c27a10c8c774de (patch) | |
tree | 9f9ddf23e427822b3641a2f991ce57f4946b0049 | |
parent | 56844fad9e73cae85c355db08efb3d2a6f249f61 (diff) |
Fix broken framework documentation
Various issues here, but the most recurring one is referencing SystemApi
from public javadoc. Remove or rewrite such references.
Also common is trying to @link IntDefs. Usually this is not necessary,
as the presence of IntDef in the @param/@return auto-generates relevant
documentation.
Bug: 303184203
Test: m docs
Change-Id: Ie59e61881c45c73fbbe08250493bd35eca268ef6
28 files changed, 44 insertions, 103 deletions
diff --git a/apex/jobscheduler/framework/java/android/app/job/JobParameters.java b/apex/jobscheduler/framework/java/android/app/job/JobParameters.java index f1403bd51049..e833bb95a302 100644 --- a/apex/jobscheduler/framework/java/android/app/job/JobParameters.java +++ b/apex/jobscheduler/framework/java/android/app/job/JobParameters.java @@ -439,7 +439,7 @@ public class JobParameters implements Parcelable { * provides an easy way to tell whether the job is being executed due to the deadline * expiring. Note: If the job is running because its deadline expired, it implies that its * constraints will not be met. However, - * {@link android.app.job.JobInfo.Builder#setPeriodic(boolean) periodic jobs} will only ever + * {@link android.app.job.JobInfo.Builder#setPeriodic(long) periodic jobs} will only ever * run when their constraints are satisfied, therefore, the constraints will still be satisfied * for a periodic job even if the deadline has expired. */ diff --git a/api/javadoc-lint-baseline b/api/javadoc-lint-baseline index c28480e4f11a..d9e72b83e46e 100644 --- a/api/javadoc-lint-baseline +++ b/api/javadoc-lint-baseline @@ -53,16 +53,6 @@ android/adservices/ondevicepersonalization/WebViewEventInput.java:21: lint: Unre android/adservices/ondevicepersonalization/WebViewEventInput.java:30: lint: Unresolved link/see tag "android.adservices.ondevicepersonalization.IsolatedWorker#onExecute() IsolatedWorker#onExecute()" in android.adservices.ondevicepersonalization.WebViewEventInput [101] android/adservices/ondevicepersonalization/WebViewEventInput.java:41: lint: Unresolved link/see tag "android.adservices.ondevicepersonalization.EventUrlProvider#createEventTrackingUrlWithResponse() EventUrlProvider#createEventTrackingUrlWithResponse()" in android.adservices.ondevicepersonalization.WebViewEventInput [101] android/adservices/ondevicepersonalization/WebViewEventOutput.java:21: lint: Unresolved link/see tag "android.adservices.ondevicepersonalization.IsolatedWorker#onWebViewEvent() IsolatedWorker#onWebViewEvent()" in android.adservices.ondevicepersonalization.WebViewEventOutput [101] -android/app/ActivityOptions.java:366: lint: Unresolved link/see tag "android.app.ComponentOptions.BackgroundActivityStartMode" in android.app.ActivityOptions [101] -android/app/ActivityOptions.java:370: lint: Unresolved link/see tag "android.app.ComponentOptions.BackgroundActivityStartMode" in android.app.ActivityOptions [101] -android/app/ActivityOptions.java:384: lint: Unresolved link/see tag "android.app.ComponentOptions.BackgroundActivityStartMode" in android.app.ActivityOptions [101] -android/app/ApplicationStartInfo.java:96: lint: Unresolved link/see tag "#START_TIMESTAMP_JAVA_CLASSLOADING_COMPLETE" in android.app.ApplicationStartInfo [101] -android/app/BroadcastOptions.java:132: lint: Unresolved link/see tag "#setDeliveryGroupMatchingFilter(android.content.IntentFilter)" in android.app.BroadcastOptions [101] -android/app/GrammaticalInflectionManager.java:60: lint: Unresolved link/see tag "android.os.Environment#getDataSystemCeDirectory(int)" in android.app.GrammaticalInflectionManager [101] -android/app/Notification.java:509: lint: Unresolved link/see tag "android.annotation.ColorInt ColorInt" in android.app.Notification [101] -android/app/Notification.java:650: lint: Unresolved link/see tag "android.annotation.ColorInt ColorInt" in android.app.Notification [101] -android/app/Notification.java:1866: lint: Unresolved link/see tag "/*missing*/" in android.app.Notification.Action [101] -android/app/Notification.java:4796: lint: Unresolved link/see tag "android.content.pm.ShortcutInfo#setLongLived() ShortcutInfo#setLongLived()" in android.app.Notification.MessagingStyle [101] android/app/admin/DevicePolicyManager.java:2670: lint: Unresolved link/see tag "android.os.UserManager#DISALLOW_CAMERA UserManager#DISALLOW_CAMERA" in android.app.admin.DevicePolicyManager [101] android/app/admin/DevicePolicyManager.java:7257: lint: Unresolved link/see tag "android.app.admin.DevicePolicyIdentifiers#USB_DATA_SIGNALING_POLICY DevicePolicyIdentifiers#USB_DATA_SIGNALING_POLICY" in android.app.admin.DevicePolicyManager [101] android/app/admin/DevicePolicyManager.java:7425: lint: Unresolved link/see tag "ACTION_DEVICE_FINANCING_STATE_CHANGED" in android.app.admin.DevicePolicyManager [101] @@ -83,17 +73,6 @@ android/app/appsearch/SearchSpec.java:244: lint: Unresolved link/see tag "Featur android/app/appsearch/SearchSpec.java:913: lint: Unresolved link/see tag "Features#NUMERIC_SEARCH" in android.app.appsearch.SearchSpec.Builder [101] android/app/appsearch/SearchSpec.java:925: lint: Unresolved link/see tag "Features#VERBATIM_SEARCH" in android.app.appsearch.SearchSpec.Builder [101] android/app/appsearch/SearchSpec.java:929: lint: Unresolved link/see tag "Features#LIST_FILTER_QUERY_LANGUAGE" in android.app.appsearch.SearchSpec.Builder [101] -android/app/job/JobParameters.java:128: lint: Unresolved link/see tag "android.app.job.JobInfo.Builder#setPeriodic(boolean) periodic jobs" in android.app.job.JobParameters [101] -android/app/sdksandbox/AppOwnedSdkSandboxInterface.java:9: lint: Unresolved link/see tag "SdkSandboxController#getAppOwnedSdkSandboxInterfaces" in android.app.sdksandbox.AppOwnedSdkSandboxInterface [101] -android/app/sdksandbox/SdkSandboxManager.java:112: lint: Unresolved link/see tag "AppOwnedSdkSandboxInterfaces" in android.app.sdksandbox.SdkSandboxManager [101] -android/content/AttributionSource.java:291: lint: Unresolved link/see tag "setNextAttributionSource" in android.content.AttributionSource.Builder [101] -android/content/Context.java:2872: lint: Unresolved link/see tag "android.telephony.MmsManager" in android.content.Context [101] -android/content/Intent.java:4734: lint: Unresolved link/see tag "android.content.pm.UserInfo#isProfile()" in android.content.Intent [101] -android/content/Intent.java:4760: lint: Unresolved link/see tag "android.content.pm.UserInfo#isProfile()" in android.content.Intent [101] -android/content/Intent.java:4778: lint: Unresolved link/see tag "android.content.pm.UserInfo#isProfile()" in android.content.Intent [101] -android/content/Intent.java:4802: lint: Unresolved link/see tag "android.content.pm.UserInfo#isProfile()" in android.content.Intent [101] -android/graphics/Paint.java:838: lint: Unresolved link/see tag "android.annotation.ColorLong ColorLong" in android.graphics.Paint [101] -android/graphics/text/LineBreaker.java:246: lint: Unresolved link/see tag "StaticLayout.Builder#setUseBoundsForWidth(boolean)" in android.graphics.text.LineBreaker.Builder [101] android/hardware/camera2/CameraCharacteristics.java:2169: lint: Unresolved link/see tag "android.hardware.camera2.CameraDevice#stream-use-case-capability-additional-guaranteed-configurations guideline" in android.hardware.camera2.CameraCharacteristics [101] android/hardware/camera2/CameraCharacteristics.java:2344: lint: Unresolved link/see tag "android.hardware.camera2.CameraDevice#concurrent-stream-guaranteed-configurations guideline" in android.hardware.camera2.CameraCharacteristics [101] android/hardware/camera2/CameraCharacteristics.java:2344: lint: Unresolved link/see tag "android.hardware.camera2.CameraDevice#concurrent-stream-guaranteed-configurations tables" in android.hardware.camera2.CameraCharacteristics [101] @@ -119,11 +98,6 @@ android/hardware/camera2/CaptureRequest.java:704: lint: Unresolved link/see tag android/hardware/camera2/CaptureRequest.java:1501: lint: Unresolved link/see tag "SessionConfiguration#setSessionParameters" in android.hardware.camera2.CaptureRequest [101] android/hardware/camera2/CaptureResult.java:923: lint: Unresolved link/see tag "SessionConfiguration#setSessionParameters" in android.hardware.camera2.CaptureResult [101] android/hardware/camera2/CaptureResult.java:2337: lint: Unresolved link/see tag "SessionConfiguration#setSessionParameters" in android.hardware.camera2.CaptureResult [101] -android/hardware/input/InputManager.java:215: lint: Unresolved link/see tag "android.hardware.input.InputManagerGlobal#getInputDevice InputManagerGlobal#getInputDevice" in android.hardware.input.InputManager.InputDeviceListener [101] -android/inputmethodservice/AbstractInputMethodService.java:155: lint: Unresolved link/see tag "android.app.ActivityThread ActivityThread" in android.inputmethodservice.AbstractInputMethodService [101] -android/inputmethodservice/InputMethodService.java:1078: lint: Unresolved link/see tag "android.widget.Editor" in android.inputmethodservice.InputMethodService [101] -android/location/GnssSignalType.java:14: lint: Unresolved link/see tag "android.location.GnssStatus.ConstellationType GnssStatus.ConstellationType" in android.location.GnssSignalType [101] -android/location/GnssSignalType.java:48: lint: Unresolved link/see tag "android.location.GnssStatus.ConstellationType GnssStatus.ConstellationType" in android.location.GnssSignalType [101] android/media/AudioAttributes.java:443: lint: Unresolved link/see tag "android.media.AudioAttributes.AttributeSdkUsage#USAGE_ALARM AttributeSdkUsage#USAGE_ALARM" in android.media.AudioAttributes.Builder [101] android/media/AudioAttributes.java:443: lint: Unresolved link/see tag "android.media.AudioAttributes.AttributeSdkUsage#USAGE_ASSISTANCE_ACCESSIBILITY AttributeSdkUsage#USAGE_ASSISTANCE_ACCESSIBILITY" in android.media.AudioAttributes.Builder [101] android/media/AudioAttributes.java:443: lint: Unresolved link/see tag "android.media.AudioAttributes.AttributeSdkUsage#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE AttributeSdkUsage#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE" in android.media.AudioAttributes.Builder [101] @@ -177,26 +151,6 @@ android/net/wifi/aware/SubscribeConfig.java:51: lint: Unresolved link/see tag "a android/net/wifi/aware/SubscribeConfig.java:51: lint: Unresolved link/see tag "android.net.wifi.WifiScanner#WIFI_BAND_5_GHZ WifiScanner#WIFI_BAND_5_GHZ" in android.net.wifi.aware.SubscribeConfig [101] android/net/wifi/aware/SubscribeConfig.java:276: lint: Unresolved link/see tag "android.net.wifi.WifiScanner#WIFI_BAND_24_GHZ WifiScanner#WIFI_BAND_24_GHZ" in android.net.wifi.aware.SubscribeConfig.Builder [101] android/net/wifi/aware/SubscribeConfig.java:276: lint: Unresolved link/see tag "android.net.wifi.WifiScanner#WIFI_BAND_5_GHZ WifiScanner#WIFI_BAND_5_GHZ" in android.net.wifi.aware.SubscribeConfig.Builder [101] -android/os/BugreportManager.java:146: lint: Unresolved link/see tag "android.os.BugreportParams#BUGREPORT_FLAG_DEFER_CONSENT BugreportParams#BUGREPORT_FLAG_DEFER_CONSENT" in android.os.BugreportManager.BugreportCallback [101] -android/os/PowerManager.java:796: lint: Unresolved link/see tag "android.os.Temperature" in android.os.PowerManager.OnThermalStatusChangedListener [101] -android/os/RemoteException.java:49: lint: Unresolved link/see tag "android.os.DeadSystemRuntimeException DeadSystemRuntimeException" in android.os.RemoteException [101] -android/provider/Settings.java:374: lint: Unresolved link/see tag "android.credentials.CredentialManager#isEnabledCredentialProviderService()" in android.provider.Settings [101] -android/provider/Settings.java:908: lint: Unresolved link/see tag "android.service.notification.NotificationAssistantService" in android.provider.Settings [101] -android/provider/Settings.java:2181: lint: Unresolved link/see tag "android.app.time.TimeManager" in android.provider.Settings.Global [101] -android/provider/Settings.java:2195: lint: Unresolved link/see tag "android.app.time.TimeManager" in android.provider.Settings.Global [101] -android/security/KeyStoreException.java:27: lint: Unresolved link/see tag "android.security.KeyStoreException.PublicErrorCode PublicErrorCode" in android.security.KeyStoreException [101] -android/service/autofill/FillResponse.java:86: lint: Unresolved link/see tag "setFieldClassificationIds" in android.service.autofill.FillResponse.Builder [101] -android/service/autofill/SaveInfo.java:623: lint: Unresolved link/see tag "FillRequest.getHints()" in android.service.autofill.SaveInfo.Builder [101] -android/service/notification/NotificationListenerService.java:417: lint: Unresolved link/see tag "android.service.notification.NotificationAssistantService notification assistant" in android.service.notification.NotificationListenerService [101] -android/service/notification/NotificationListenerService.java:435: lint: Unresolved link/see tag "android.service.notification.NotificationAssistantService notification assistant" in android.service.notification.NotificationListenerService [101] -android/service/notification/NotificationListenerService.java:1155: 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/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/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/view/PixelCopy.java:468: lint: Unresolved link/see tag "android.view.PixelCopy.CopyResultStatus CopyResultStatus" in android.view.PixelCopy.Result [101] -android/window/BackEvent.java:24: lint: Unresolved link/see tag "android.window.BackMotionEvent BackMotionEvent" in android.window.BackEvent [101] android/net/wifi/SoftApConfiguration.java:173: lint: Unresolved link/see tag "android.net.wifi.SoftApConfiguration.Builder#setShutdownTimeoutMillis(long)" in android.net.wifi.SoftApConfiguration [101] android/os/UserManager.java:2384: lint: Unresolved link/see tag "android.annotation.UserHandleAware @UserHandleAware" in android.os.UserManager [101] @@ -218,8 +172,3 @@ 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: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] - -android/os/BatteryStatsManager.java:260: lint: Invalid tag: @Deprecated [131] -android/os/BatteryStatsManager.java:275: lint: Invalid tag: @Deprecated [131] - -java/lang/ClassLoader.java:853: lint: Unknown tag: @systemProperty [103] diff --git a/core/java/android/app/ActivityOptions.java b/core/java/android/app/ActivityOptions.java index 895dde760058..f2c00517ad16 100644 --- a/core/java/android/app/ActivityOptions.java +++ b/core/java/android/app/ActivityOptions.java @@ -2073,9 +2073,7 @@ public class ActivityOptions extends ComponentOptions { * Allow a {@link PendingIntent} to use the privilege of its creator to start background * activities. * - * @param mode the {@link android.app.ComponentOptions.BackgroundActivityStartMode} being set - * @throws IllegalArgumentException is the value is not a valid - * {@link android.app.ComponentOptions.BackgroundActivityStartMode} + * @param mode the mode being set */ @NonNull public ActivityOptions setPendingIntentCreatorBackgroundActivityStartMode( @@ -2088,7 +2086,7 @@ public class ActivityOptions extends ComponentOptions { * Returns the mode to start background activities granted by the creator of the * {@link PendingIntent}. * - * @return the {@link android.app.ComponentOptions.BackgroundActivityStartMode} currently set + * @return the mode currently set */ public @BackgroundActivityStartMode int getPendingIntentCreatorBackgroundActivityStartMode() { return mPendingIntentCreatorBackgroundActivityStartMode; diff --git a/core/java/android/app/BroadcastOptions.java b/core/java/android/app/BroadcastOptions.java index 9549ebf698a8..41b400459526 100644 --- a/core/java/android/app/BroadcastOptions.java +++ b/core/java/android/app/BroadcastOptions.java @@ -843,8 +843,7 @@ public class BroadcastOptions extends ComponentOptions { * considered to be in the same delivery group as this iff it has the same {@code namespace} * and {@code key}. * - * <p> If neither matching key using this API nor matching filter using - * {@link #setDeliveryGroupMatchingFilter(IntentFilter)} is specified, then by default + * <p> If not matching key using this API then by default * {@link Intent#filterEquals(Intent)} will be used to identify the delivery group. */ @NonNull diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java index dd7db23d668b..94e1292a7554 100644 --- a/core/java/android/app/Notification.java +++ b/core/java/android/app/Notification.java @@ -1514,13 +1514,13 @@ public class Notification implements Parcelable /** * {@link #extras} key: the color used as a hint for the Answer action button of a - * {@link android.app.Notification.CallStyle} notification. This extra is a {@link ColorInt}. + * {@link android.app.Notification.CallStyle} notification. This extra is a {@code ColorInt}. */ public static final String EXTRA_ANSWER_COLOR = "android.answerColor"; /** * {@link #extras} key: the color used as a hint for the Decline or Hang Up action button of a - * {@link android.app.Notification.CallStyle} notification. This extra is a {@link ColorInt}. + * {@link android.app.Notification.CallStyle} notification. This extra is a {@code ColorInt}. */ public static final String EXTRA_DECLINE_COLOR = "android.declineColor"; @@ -1704,7 +1704,7 @@ public class Notification implements Parcelable private static final String EXTRA_DATA_ONLY_INPUTS = "android.extra.DATA_ONLY_INPUTS"; /** - * {@link }: No semantic action defined. + * No semantic action defined. */ public static final int SEMANTIC_ACTION_NONE = 0; @@ -7923,7 +7923,7 @@ public class Notification implements Parcelable * (via {@link Notification.Builder#setShortcutId(String)}) are displayed in a dedicated * conversation section in the shade above non-conversation alerting and silence notifications. * To be a valid conversation shortcut, the shortcut must be a - * {@link ShortcutInfo#setLongLived()} dynamic or cached sharing shortcut. + * {@link ShortcutInfo.Builder#setLongLived(boolean)} dynamic or cached sharing shortcut. * * <p> * This class is a "rebuilder": It attaches to a Builder object and modifies its behavior. diff --git a/core/java/android/content/AttributionSource.java b/core/java/android/content/AttributionSource.java index bfc1eec829e8..20eae9ade429 100644 --- a/core/java/android/content/AttributionSource.java +++ b/core/java/android/content/AttributionSource.java @@ -730,7 +730,7 @@ public final class AttributionSource implements Parcelable { /** * The next app to receive the permission protected data. * - * @deprecated Use {@link setNextAttributionSource} instead. + * @deprecated Use {@link #setNextAttributionSource} instead. */ @Deprecated public @NonNull Builder setNext(@Nullable AttributionSource value) { diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java index b6a98a5b8f83..884351b57045 100644 --- a/core/java/android/content/Context.java +++ b/core/java/android/content/Context.java @@ -4357,7 +4357,6 @@ public abstract class Context { * @see android.telephony.CarrierConfigManager * @see #EUICC_SERVICE * @see android.telephony.euicc.EuiccManager - * @see android.telephony.MmsManager * @see #INPUT_METHOD_SERVICE * @see android.view.inputmethod.InputMethodManager * @see #UI_MODE_SERVICE diff --git a/core/java/android/content/Intent.java b/core/java/android/content/Intent.java index 5f4c05f001ff..1eb2cd174a7f 100644 --- a/core/java/android/content/Intent.java +++ b/core/java/android/content/Intent.java @@ -4180,7 +4180,7 @@ public class Intent implements Parcelable, Cloneable { * new state of quiet mode. This is only sent to registered receivers, not manifest receivers. * * <p>This broadcast is similar to {@link #ACTION_MANAGED_PROFILE_AVAILABLE} but functions as a - * generic broadcast for all users of type {@link android.content.pm.UserInfo#isProfile()}}. + * generic broadcast for all profile users. */ @FlaggedApi(FLAG_ALLOW_PRIVATE_PROFILE) public static final String ACTION_PROFILE_AVAILABLE = @@ -4194,7 +4194,7 @@ public class Intent implements Parcelable, Cloneable { * new state of quiet mode. This is only sent to registered receivers, not manifest receivers. * * <p>This broadcast is similar to {@link #ACTION_MANAGED_PROFILE_UNAVAILABLE} but functions as - * a generic broadcast for all users of type {@link android.content.pm.UserInfo#isProfile()}}. + * a generic broadcast for all profile users. */ @FlaggedApi(FLAG_ALLOW_PRIVATE_PROFILE) public static final String ACTION_PROFILE_UNAVAILABLE = @@ -4222,7 +4222,7 @@ public class Intent implements Parcelable, Cloneable { * that was removed. * * <p>This broadcast is similar to {@link #ACTION_MANAGED_PROFILE_REMOVED} but functions as a - * generic broadcast for all users of type {@link android.content.pm.UserInfo#isProfile()}}. + * generic broadcast for all profile users. * It is sent in addition to the {@link #ACTION_MANAGED_PROFILE_REMOVED} broadcast when a * managed user is removed. * @@ -4242,7 +4242,7 @@ public class Intent implements Parcelable, Cloneable { * that was added. * * <p>This broadcast is similar to {@link #ACTION_MANAGED_PROFILE_ADDED} but functions as a - * generic broadcast for all users of type {@link android.content.pm.UserInfo#isProfile()}}. + * generic broadcast for all profile users. * It is sent in addition to the {@link #ACTION_MANAGED_PROFILE_ADDED} broadcast when a * managed user is added. * diff --git a/core/java/android/hardware/input/InputManager.java b/core/java/android/hardware/input/InputManager.java index ff1a6acd8e4e..7b8419e6c6f7 100644 --- a/core/java/android/hardware/input/InputManager.java +++ b/core/java/android/hardware/input/InputManager.java @@ -1373,7 +1373,7 @@ public final class InputManager { public interface InputDeviceListener { /** * Called whenever an input device has been added to the system. - * Use {@link InputManagerGlobal#getInputDevice} to get more information about the device. + * Use {@link #getInputDevice(int)} to get more information about the device. * * @param deviceId The id of the input device that was added. */ diff --git a/core/java/android/inputmethodservice/InputMethodService.java b/core/java/android/inputmethodservice/InputMethodService.java index 582c5c0c4dd4..4c2bbc18f2db 100644 --- a/core/java/android/inputmethodservice/InputMethodService.java +++ b/core/java/android/inputmethodservice/InputMethodService.java @@ -3231,7 +3231,7 @@ public class InputMethodService extends AbstractInputMethodService { } /** - * Called when the user tapped or clicked an {@link android.widget.Editor}. + * Called when the user tapped or clicked an editor. * This can be useful when IME makes a decision of showing Virtual keyboard based on what * {@link MotionEvent#getToolType(int)} was used to click the editor. * e.g. when toolType is {@link MotionEvent#TOOL_TYPE_STYLUS}, IME may choose to show a diff --git a/core/java/android/os/BugreportManager.java b/core/java/android/os/BugreportManager.java index 086b0e5d4b05..58def6ef7961 100644 --- a/core/java/android/os/BugreportManager.java +++ b/core/java/android/os/BugreportManager.java @@ -143,10 +143,11 @@ public final class BugreportManager { */ public void onError(@BugreportErrorCode int errorCode) {} - /** Called when taking bugreport finishes successfully. + /** + * Called when taking bugreport finishes successfully. * * <p>This callback will be invoked if the - * {@link BugreportParams#BUGREPORT_FLAG_DEFER_CONSENT} flag is not set. + * {@code BugreportParams#BUGREPORT_FLAG_DEFER_CONSENT} flag is not set. */ public void onFinished() {} diff --git a/core/java/android/os/PowerManager.java b/core/java/android/os/PowerManager.java index 4174c1c13c94..fce715ade5af 100644 --- a/core/java/android/os/PowerManager.java +++ b/core/java/android/os/PowerManager.java @@ -2670,7 +2670,7 @@ public final class PowerManager { /** * Called when overall thermal throttling status changed. - * @param status defined in {@link android.os.Temperature}. + * @param status the status */ void onThermalStatusChanged(@ThermalStatus int status); } diff --git a/core/java/android/os/RemoteException.java b/core/java/android/os/RemoteException.java index 970f4192c36c..ace5f7e8393f 100644 --- a/core/java/android/os/RemoteException.java +++ b/core/java/android/os/RemoteException.java @@ -66,7 +66,7 @@ public class RemoteException extends AndroidException { /** * Rethrow this exception when we know it came from the system server. This * gives us an opportunity to throw a nice clean - * {@link DeadSystemRuntimeException} signal to avoid spamming logs with + * {@code DeadSystemRuntimeException} signal to avoid spamming logs with * misleading stack traces. * <p> * Apps making calls into the system server may end up persisting internal diff --git a/core/java/android/provider/Settings.java b/core/java/android/provider/Settings.java index b19a034d4628..b34e09f2c97a 100644 --- a/core/java/android/provider/Settings.java +++ b/core/java/android/provider/Settings.java @@ -1800,7 +1800,6 @@ public final class Settings { * Input: Nothing. * <p> * Output: Nothing. - * @see android.service.notification.NotificationAssistantService */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_NOTIFICATION_ASSISTANT_SETTINGS = @@ -2507,8 +2506,8 @@ public final class Settings { * to the caller package. * <p> * <b>NOTE: </b> Applications should call - * {@link android.credentials.CredentialManager#isEnabledCredentialProviderService()} - * and only use this action to start an activity if they return {@code false}. + * {@link android.credentials.CredentialManager#isEnabledCredentialProviderService( + * ComponentName)} and only use this action to start an activity if they return {@code false}. */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_CREDENTIAL_PROVIDER = @@ -12375,7 +12374,7 @@ public final class Settings { * Value to specify if the device's UTC system clock should be set automatically, e.g. using * telephony signals like NITZ, or other sources like GNSS or NTP. * - * <p>Prefer {@link android.app.time.TimeManager} API calls to determine the state of + * <p>Prefer {@code android.app.time.TimeManager} API calls to determine the state of * automatic time detection instead of directly observing this setting as it may be ignored * by the time_detector service under various conditions. * @@ -12388,7 +12387,7 @@ public final class Settings { * Value to specify if the device's time zone system property should be set automatically, * e.g. using telephony signals like MCC and NITZ, or other mechanisms like the location. * - * <p>Prefer {@link android.app.time.TimeManager} API calls to determine the state of + * <p>Prefer {@code android.app.time.TimeManager} API calls to determine the state of * automatic time zone detection instead of directly observing this setting as it may be * ignored by the time_zone_detector service under various conditions. * diff --git a/core/java/android/service/autofill/FillResponse.java b/core/java/android/service/autofill/FillResponse.java index 3fb94ee93c14..7ea74d375ffb 100644 --- a/core/java/android/service/autofill/FillResponse.java +++ b/core/java/android/service/autofill/FillResponse.java @@ -406,7 +406,7 @@ public final class FillResponse implements Parcelable { * * Call this when a field has been detected with a type. * - * Altough similiarly named with {@link setFieldClassificationIds}, + * Altough similiarly named with {@link #setFieldClassificationIds}, * it provides a different functionality - setFieldClassificationIds should * be used when a field is only suspected to be Autofillable. * This method should be used when a field is certainly Autofillable diff --git a/core/java/android/service/autofill/SaveInfo.java b/core/java/android/service/autofill/SaveInfo.java index 954cc960665f..53706cd3f887 100644 --- a/core/java/android/service/autofill/SaveInfo.java +++ b/core/java/android/service/autofill/SaveInfo.java @@ -813,7 +813,7 @@ public final class SaveInfo implements Parcelable { * If no {@link #Builder(int, AutofillId[]) required ids}, * or {@link #setOptionalIds(AutofillId[]) optional ids}, or {@link #FLAG_DELAY_SAVE} * were set, Save Dialog will only be triggered if platform detection is enabled, which - * is indicated when {@link FillRequest.getHints()} is not empty. + * is indicated when {@link FillRequest#getHints()} is not empty. */ public SaveInfo build() { throwIfDestroyed(); diff --git a/core/java/android/service/notification/NotificationListenerService.java b/core/java/android/service/notification/NotificationListenerService.java index 1cfff14b2d7c..759953e4aca4 100644 --- a/core/java/android/service/notification/NotificationListenerService.java +++ b/core/java/android/service/notification/NotificationListenerService.java @@ -896,8 +896,7 @@ public abstract class NotificationListenerService extends Service { * <p>This method will throw a security exception if you don't have access to notifications * for the given user.</p> * <p>The caller must have {@link CompanionDeviceManager#getAssociations() an associated - * device} or be the {@link NotificationAssistantService notification assistant} in order to - * use this method. + * device} or be the notification assistant in order to use this method. * * @param pkg The package to retrieve channels for. */ @@ -920,8 +919,7 @@ public abstract class NotificationListenerService extends Service { * <p>This method will throw a security exception if you don't have access to notifications * for the given user.</p> * <p>The caller must have {@link CompanionDeviceManager#getAssociations() an associated - * device} or be the {@link NotificationAssistantService notification assistant} in order to - * use this method. + * device} or be the notification assistant in order to use this method. * * @param pkg The package to retrieve channel groups for. */ @@ -2001,7 +1999,7 @@ public abstract class NotificationListenerService extends Service { /** * Returns a list of smart {@link Notification.Action} that can be added by the - * {@link NotificationAssistantService} + * notification assistant. */ public @NonNull List<Notification.Action> getSmartActions() { return mSmartActions == null ? Collections.emptyList() : mSmartActions; @@ -2022,8 +2020,7 @@ public abstract class NotificationListenerService extends Service { } /** - * Returns a list of smart replies that can be added by the - * {@link NotificationAssistantService} + * Returns a list of smart replies that can be added by the notification assistant. */ public @NonNull List<CharSequence> getSmartReplies() { return mSmartReplies == null ? Collections.emptyList() : mSmartReplies; diff --git a/core/java/android/service/quickaccesswallet/WalletCard.java b/core/java/android/service/quickaccesswallet/WalletCard.java index 4a4fd041fb19..bf129c551605 100644 --- a/core/java/android/service/quickaccesswallet/WalletCard.java +++ b/core/java/android/service/quickaccesswallet/WalletCard.java @@ -372,9 +372,9 @@ public final class WalletCard implements Parcelable { } /** - * Set of locations this card might be useful at. If {@link - * PackageManager.FEATURE_WALLET_LOCATION_BASED_SUGGESTIONS} is enabled, the card might be - * shown to the user when a user is near one of these locations. + * Set of locations this card might be useful at. If + * {@link android.content.pm.PackageManager#FEATURE_WALLET_LOCATION_BASED_SUGGESTIONS} is + * enabled, the card might be shown to the user when a user is near one of these locations. */ @NonNull public Builder setCardLocations(@NonNull List<Location> cardLocations) { diff --git a/core/java/android/service/voice/VoiceInteractionSession.java b/core/java/android/service/voice/VoiceInteractionSession.java index cabcae30851f..d40b39e18edb 100644 --- a/core/java/android/service/voice/VoiceInteractionSession.java +++ b/core/java/android/service/voice/VoiceInteractionSession.java @@ -1809,7 +1809,7 @@ public class VoiceInteractionSession implements KeyEvent.Callback, ComponentCall * in milliseconds of the KeyEvent that triggered Assistant and * Intent.EXTRA_ASSIST_INPUT_DEVICE_ID (android.intent.extra.ASSIST_INPUT_DEVICE_ID) * referring to the device that sent the request. Starting from Android 14, the system will - * add {@link VoiceInteractionService#KEY_SHOW_SESSION_ID}, the Bundle is not null. But the + * add {@link #KEY_SHOW_SESSION_ID}, the Bundle is not null. But the * application should handle null case before Android 14. * @param showFlags The show flags originally provided to * {@link VoiceInteractionService#showSession VoiceInteractionService.showSession}. diff --git a/core/java/android/text/DynamicLayout.java b/core/java/android/text/DynamicLayout.java index 8862f1d74ab1..a0cd0748f509 100644 --- a/core/java/android/text/DynamicLayout.java +++ b/core/java/android/text/DynamicLayout.java @@ -1274,7 +1274,7 @@ public class DynamicLayout extends Layout { } /** - * Gets the {@link LineBreakconfig} used in this DynamicLayout. + * Gets the {@link LineBreakConfig} used in this DynamicLayout. * Use this only to consult the LineBreakConfig's properties and not * to change them. * diff --git a/core/java/android/text/WordSegmentFinder.java b/core/java/android/text/WordSegmentFinder.java index be002f3102d3..b0a70eae902a 100644 --- a/core/java/android/text/WordSegmentFinder.java +++ b/core/java/android/text/WordSegmentFinder.java @@ -24,7 +24,7 @@ import android.text.method.WordIterator; /** * Implementation of {@link SegmentFinder} using words as the text segment. Word boundaries are - * found using {@link WordIterator}. Whitespace characters are excluded, so they are not included in + * found using {@code WordIterator}. Whitespace characters are excluded, so they are not included in * any text segments. * * <p>For example, the text "Hello, World!" would be subdivided into four text segments: "Hello", diff --git a/core/java/android/window/BackEvent.java b/core/java/android/window/BackEvent.java index f53737abf707..55623608b025 100644 --- a/core/java/android/window/BackEvent.java +++ b/core/java/android/window/BackEvent.java @@ -49,7 +49,7 @@ public final class BackEvent { private final int mSwipeEdge; /** - * Creates a new {@link BackMotionEvent} instance. + * Creates a new {@link BackEvent} instance. * * @param touchX Absolute X location of the touch point of this event. * @param touchY Absolute Y location of the touch point of this event. diff --git a/core/java/android/window/WindowProviderService.java b/core/java/android/window/WindowProviderService.java index 611da3cec5c6..0cbfcc501918 100644 --- a/core/java/android/window/WindowProviderService.java +++ b/core/java/android/window/WindowProviderService.java @@ -155,7 +155,7 @@ public abstract class WindowProviderService extends Service implements WindowPro } /** - * Override {@link Service}'s empty implementation and listen to {@link ActivityThread} for + * Override {@link Service}'s empty implementation and listen to {@code ActivityThread} for * low memory and trim memory events. */ @Override diff --git a/graphics/java/android/graphics/Paint.java b/graphics/java/android/graphics/Paint.java index db1cc446b2d6..9fde0fd6e6ab 100644 --- a/graphics/java/android/graphics/Paint.java +++ b/graphics/java/android/graphics/Paint.java @@ -1609,7 +1609,7 @@ public class Paint { /** * Returns the color of the shadow layer. * - * @return the shadow layer's color encoded as a {@link ColorLong}. + * @return the shadow layer's color encoded as a {@code ColorLong}. * @see #setShadowLayer(float,float,float,int) * @see #setShadowLayer(float,float,float,long) * @see Color diff --git a/graphics/java/android/graphics/text/LineBreaker.java b/graphics/java/android/graphics/text/LineBreaker.java index dc2e794a1df4..0e3fb163ef75 100644 --- a/graphics/java/android/graphics/text/LineBreaker.java +++ b/graphics/java/android/graphics/text/LineBreaker.java @@ -249,7 +249,7 @@ public class LineBreaker { * @param useBoundsForWidth True for using bounding box, false for advances. * @return this builder instance * @see Layout#getUseBoundsForWidth() - * @see StaticLayout.Builder#setUseBoundsForWidth(boolean) + * @see android.text.StaticLayout.Builder#setUseBoundsForWidth(boolean) */ @FlaggedApi(FLAG_USE_BOUNDS_FOR_WIDTH) public @NonNull Builder setUseBoundsForWidth(boolean useBoundsForWidth) { diff --git a/graphics/java/android/view/PixelCopy.java b/graphics/java/android/view/PixelCopy.java index 0e198d5c56ec..e6de5978ceb0 100644 --- a/graphics/java/android/view/PixelCopy.java +++ b/graphics/java/android/view/PixelCopy.java @@ -322,7 +322,7 @@ public final class PixelCopy { } /** - * Returns the {@link CopyResultStatus} of the copy request. + * Returns the status of the copy request. */ public @CopyResultStatus int getStatus() { return mStatus; diff --git a/keystore/java/android/security/KeyStoreException.java b/keystore/java/android/security/KeyStoreException.java index 253d70465720..5825facee021 100644 --- a/keystore/java/android/security/KeyStoreException.java +++ b/keystore/java/android/security/KeyStoreException.java @@ -319,7 +319,7 @@ public class KeyStoreException extends Exception { /** * Returns one of the error codes exported by the class. * - * @return a public error code, one of the values in {@link PublicErrorCode}. + * @return a public error code */ @PublicErrorCode public int getNumericErrorCode() { diff --git a/location/java/android/location/GnssSignalType.java b/location/java/android/location/GnssSignalType.java index 16c3f2ed27d8..2dd67f0c12aa 100644 --- a/location/java/android/location/GnssSignalType.java +++ b/location/java/android/location/GnssSignalType.java @@ -34,8 +34,7 @@ public final class GnssSignalType implements Parcelable { /** * Creates a {@link GnssSignalType} with a full list of parameters. * - * @param constellationType the constellation type as defined in - * {@link GnssStatus.ConstellationType} + * @param constellationType the constellation type * @param carrierFrequencyHz the carrier frequency in Hz * @param codeType the code type as defined in {@link GnssMeasurement#getCodeType()} */ @@ -66,7 +65,7 @@ public final class GnssSignalType implements Parcelable { this.mCodeType = codeType; } - /** Returns the {@link GnssStatus.ConstellationType}. */ + /** Returns the constellation type. */ @GnssStatus.ConstellationType public int getConstellationType() { return mConstellationType; |