diff options
author | Andrew Sapperstein <asapperstein@google.com> | 2020-04-28 12:29:20 -0700 |
---|---|---|
committer | Andrew Sapperstein <asapperstein@google.com> | 2020-05-01 00:42:22 +0000 |
commit | 1f6e22cbd88f69b81dd93011853f077780e9dfa8 (patch) | |
tree | ebc5dae910d1e172493487e5f39a6899f36517d2 /core/java | |
parent | da820447b23a17b1c3f5fd78049e1c795049f44f (diff) |
Fix broken @see tags in public documentation.
These were previously being suppressed by doclava but with this change,
all failures are fixed and the suppression logic has been removed.
To fix the issues, there were a few possible changes made:
- broken reference to a public API (such as incorrect parameters): fixed
- unnecessary @link inside an @see tag: fixed
- @see referring to an @hide or @SystemApi: reference removed
- broken references to inner class constructors
- worked around by fully qualifying the constructor
Bug: 6963924
Test: make doc-comment-check-docs
Change-Id: Ifbdce2de96cdffa560bd90f549fa7184d1f9af85
Merged-In: Ifbdce2de96cdffa560bd90f549fa7184d1f9af85
Diffstat (limited to 'core/java')
18 files changed, 22 insertions, 44 deletions
diff --git a/core/java/android/app/Activity.java b/core/java/android/app/Activity.java index b6f61a2b8f01..4f1d7f2c761c 100644 --- a/core/java/android/app/Activity.java +++ b/core/java/android/app/Activity.java @@ -3618,7 +3618,6 @@ public class Activity extends ContextThemeWrapper * To receive this callback, you must return true from onKeyDown for the current * event stream. * - * @see KeyEvent.Callback#onKeyLongPress() * @see KeyEvent.Callback#onKeyLongPress(int, KeyEvent) */ public boolean onKeyLongPress(int keyCode, KeyEvent event) { diff --git a/core/java/android/app/ActivityManager.java b/core/java/android/app/ActivityManager.java index bdaa44034565..85cd21dec283 100644 --- a/core/java/android/app/ActivityManager.java +++ b/core/java/android/app/ActivityManager.java @@ -2082,8 +2082,7 @@ public class ActivityManager { * has access to it. * * @see ActivityOptions#setLaunchDisplayId(int) - * @see android.view.Display.FLAG_PRIVATE - * @see android.view.Display.TYPE_VIRTUAL + * @see android.view.Display#FLAG_PRIVATE * * @param context Source context, from which an activity will be started. * @param displayId Target display id. diff --git a/core/java/android/app/NotificationManager.java b/core/java/android/app/NotificationManager.java index e25558f16f26..925586feaf1d 100644 --- a/core/java/android/app/NotificationManager.java +++ b/core/java/android/app/NotificationManager.java @@ -294,7 +294,7 @@ public class NotificationManager { * </p> * </p> * - * @see {@link #addAutomaticZenRule(AutomaticZenRule)} + * @see #addAutomaticZenRule(AutomaticZenRule) */ @SdkConstant(SdkConstant.SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_AUTOMATIC_ZEN_RULE = diff --git a/core/java/android/app/backup/BackupManager.java b/core/java/android/app/backup/BackupManager.java index dc815b631e46..067a35fe1aba 100644 --- a/core/java/android/app/backup/BackupManager.java +++ b/core/java/android/app/backup/BackupManager.java @@ -803,7 +803,7 @@ public class BackupManager { * has a work profile that was restored from another work profile with serial number * {@code ancestralSerialNumber}. * - * @see UserManager#getSerialNumberForUser(UserHandle) + * @see android.os.UserManager#getSerialNumberForUser(UserHandle) */ @Nullable public UserHandle getUserForAncestralSerialNumber(long ancestralSerialNumber) { diff --git a/core/java/android/app/role/RoleManager.java b/core/java/android/app/role/RoleManager.java index 2eb9459af877..4e5443a18bf2 100644 --- a/core/java/android/app/role/RoleManager.java +++ b/core/java/android/app/role/RoleManager.java @@ -102,8 +102,6 @@ public final class RoleManager { /** * The name of the emergency role - * - * @see android.telephony.TelephonyManager#ACTION_EMERGENCY_ASSISTANCE */ public static final String ROLE_EMERGENCY = "android.app.role.EMERGENCY"; diff --git a/core/java/android/content/Context.java b/core/java/android/content/Context.java index 3ed585c18e57..6e0ce3ff032a 100644 --- a/core/java/android/content/Context.java +++ b/core/java/android/content/Context.java @@ -3519,7 +3519,6 @@ public abstract class Context { * @see android.telephony.CarrierConfigManager * @see #EUICC_SERVICE * @see android.telephony.euicc.EuiccManager - * @see #MMS_SERVICE * @see android.telephony.MmsManager * @see #INPUT_METHOD_SERVICE * @see android.view.inputmethod.InputMethodManager diff --git a/core/java/android/net/Ikev2VpnProfile.java b/core/java/android/net/Ikev2VpnProfile.java index afa63039b6f7..836624beb3b2 100644 --- a/core/java/android/net/Ikev2VpnProfile.java +++ b/core/java/android/net/Ikev2VpnProfile.java @@ -803,7 +803,7 @@ public final class Ikev2VpnProfile extends PlatformVpnProfile { * @param isMetered {@code true} if the VPN network should be treated as metered regardless * of underlying network meteredness. Defaults to {@code true}. * @return this {@link Builder} object to facilitate chaining of method calls - * @see NetworkCapabilities.NET_CAPABILITY_NOT_METERED + * @see NetworkCapabilities#NET_CAPABILITY_NOT_METERED */ @NonNull public Builder setMetered(boolean isMetered) { diff --git a/core/java/android/net/VpnService.java b/core/java/android/net/VpnService.java index 63e510733907..9c2c5b839302 100644 --- a/core/java/android/net/VpnService.java +++ b/core/java/android/net/VpnService.java @@ -836,7 +836,7 @@ public class VpnService extends Service { * @param isMetered {@code true} if VPN network should be treated as metered regardless of * underlying network meteredness * @return this {@link Builder} object to facilitate chaining method calls - * @see #setUnderlyingNetworks(Networks[]) + * @see #setUnderlyingNetworks(Network[]) * @see ConnectivityManager#isActiveNetworkMetered() */ @NonNull diff --git a/core/java/android/os/StrictMode.java b/core/java/android/os/StrictMode.java index 3faaff73a0ea..81457074f2fc 100644 --- a/core/java/android/os/StrictMode.java +++ b/core/java/android/os/StrictMode.java @@ -1015,7 +1015,6 @@ public final class StrictMode { * behaviors or empty states. Instead, apps should store data needed * while a user is locked under device protected storage areas. * - * @see Context#createCredentialProtectedStorageContext() * @see Context#createDeviceProtectedStorageContext() */ public @NonNull Builder detectCredentialProtectedWhileLocked() { diff --git a/core/java/android/os/VibrationEffect.java b/core/java/android/os/VibrationEffect.java index 75b4724c7d26..890057371471 100644 --- a/core/java/android/os/VibrationEffect.java +++ b/core/java/android/os/VibrationEffect.java @@ -55,21 +55,16 @@ public abstract class VibrationEffect implements Parcelable { /** * A click effect. Use this effect as a baseline, as it's the most common type of click effect. - * - * @see #get(int) */ public static final int EFFECT_CLICK = Effect.CLICK; /** * A double click effect. - * - * @see #get(int) */ public static final int EFFECT_DOUBLE_CLICK = Effect.DOUBLE_CLICK; /** * A tick effect. This effect is less strong compared to {@link #EFFECT_CLICK}. - * @see #get(int) */ public static final int EFFECT_TICK = Effect.TICK; @@ -93,7 +88,6 @@ public abstract class VibrationEffect implements Parcelable { /** * A heavy click effect. This effect is stronger than {@link #EFFECT_CLICK}. - * @see #get(int) */ public static final int EFFECT_HEAVY_CLICK = Effect.HEAVY_CLICK; diff --git a/core/java/android/os/strictmode/CredentialProtectedWhileLockedViolation.java b/core/java/android/os/strictmode/CredentialProtectedWhileLockedViolation.java index 12503f650ab5..89cd43003529 100644 --- a/core/java/android/os/strictmode/CredentialProtectedWhileLockedViolation.java +++ b/core/java/android/os/strictmode/CredentialProtectedWhileLockedViolation.java @@ -28,7 +28,6 @@ import android.content.Context; * store data needed while a user is locked under device protected storage * areas. * - * @see Context#createCredentialProtectedStorageContext() * @see Context#createDeviceProtectedStorageContext() */ public final class CredentialProtectedWhileLockedViolation extends Violation { diff --git a/core/java/android/provider/CalendarContract.java b/core/java/android/provider/CalendarContract.java index 9c6c92ace483..17fae1cafe62 100644 --- a/core/java/android/provider/CalendarContract.java +++ b/core/java/android/provider/CalendarContract.java @@ -797,7 +797,6 @@ public final class CalendarContract { * to changes. * * @see DevicePolicyManager#getCrossProfileCalendarPackages(ComponentName) - * @see Settings.Secure#CROSS_PROFILE_CALENDAR_ENABLED */ @NonNull public static final Uri ENTERPRISE_CONTENT_URI = @@ -1796,7 +1795,6 @@ public final class CalendarContract { * to changes. * * @see DevicePolicyManager#getCrossProfileCalendarPackages(ComponentName) - * @see Settings.Secure#CROSS_PROFILE_CALENDAR_ENABLED */ @NonNull public static final Uri ENTERPRISE_CONTENT_URI = @@ -2010,7 +2008,6 @@ public final class CalendarContract { * {@link DevicePolicyManager#setCrossProfileCalendarPackages(ComponentName, Set)}. * * @see DevicePolicyManager#getCrossProfileCalendarPackages(ComponentName) - * @see Settings.Secure#CROSS_PROFILE_CALENDAR_ENABLED */ @NonNull public static final Uri ENTERPRISE_CONTENT_URI = diff --git a/core/java/android/provider/DocumentsContract.java b/core/java/android/provider/DocumentsContract.java index 4bbd213753c2..3980a5f75eda 100644 --- a/core/java/android/provider/DocumentsContract.java +++ b/core/java/android/provider/DocumentsContract.java @@ -23,7 +23,6 @@ import android.annotation.NonNull; import android.annotation.Nullable; import android.annotation.SystemApi; import android.compat.annotation.UnsupportedAppUsage; -import android.content.ContentInterface; import android.content.ContentResolver; import android.content.Context; import android.content.Intent; @@ -248,14 +247,14 @@ public final class DocumentsContract { * Get string array identifies the type or types of metadata returned * using DocumentsContract#getDocumentMetadata. * - * @see #getDocumentMetadata(ContentInterface, Uri) + * @see #getDocumentMetadata(ContentResolver, Uri) */ public static final String METADATA_TYPES = "android:documentMetadataTypes"; /** * Get Exif information using DocumentsContract#getDocumentMetadata. * - * @see #getDocumentMetadata(ContentInterface, Uri) + * @see #getDocumentMetadata(ContentResolver, Uri) */ public static final String METADATA_EXIF = "android:documentExif"; @@ -263,7 +262,7 @@ public final class DocumentsContract { * Get total count of all documents currently stored under the given * directory tree. Only valid for {@link Document#MIME_TYPE_DIR} documents. * - * @see #getDocumentMetadata(ContentInterface, Uri) + * @see #getDocumentMetadata(ContentResolver, Uri) */ public static final String METADATA_TREE_COUNT = "android:metadataTreeCount"; @@ -271,7 +270,7 @@ public final class DocumentsContract { * Get total size of all documents currently stored under the given * directory tree. Only valid for {@link Document#MIME_TYPE_DIR} documents. * - * @see #getDocumentMetadata(ContentInterface, Uri) + * @see #getDocumentMetadata(ContentResolver, Uri) */ public static final String METADATA_TREE_SIZE = "android:metadataTreeSize"; @@ -395,7 +394,7 @@ public final class DocumentsContract { * Flag indicating that a document can be represented as a thumbnail. * * @see #COLUMN_FLAGS - * @see DocumentsContract#getDocumentThumbnail(ContentInterface, Uri, + * @see DocumentsContract#getDocumentThumbnail(ContentResolver, Uri, * Point, CancellationSignal) * @see DocumentsProvider#openDocumentThumbnail(String, Point, * android.os.CancellationSignal) @@ -421,7 +420,7 @@ public final class DocumentsContract { * Flag indicating that a document is deletable. * * @see #COLUMN_FLAGS - * @see DocumentsContract#deleteDocument(ContentInterface, Uri) + * @see DocumentsContract#deleteDocument(ContentResolver, Uri) * @see DocumentsProvider#deleteDocument(String) */ public static final int FLAG_SUPPORTS_DELETE = 1 << 2; @@ -459,7 +458,7 @@ public final class DocumentsContract { * Flag indicating that a document can be renamed. * * @see #COLUMN_FLAGS - * @see DocumentsContract#renameDocument(ContentInterface, Uri, String) + * @see DocumentsContract#renameDocument(ContentResolver, Uri, String) * @see DocumentsProvider#renameDocument(String, String) */ public static final int FLAG_SUPPORTS_RENAME = 1 << 6; @@ -469,7 +468,7 @@ public final class DocumentsContract { * within the same document provider. * * @see #COLUMN_FLAGS - * @see DocumentsContract#copyDocument(ContentInterface, Uri, Uri) + * @see DocumentsContract#copyDocument(ContentResolver, Uri, Uri) * @see DocumentsProvider#copyDocument(String, String) */ public static final int FLAG_SUPPORTS_COPY = 1 << 7; @@ -479,7 +478,7 @@ public final class DocumentsContract { * within the same document provider. * * @see #COLUMN_FLAGS - * @see DocumentsContract#moveDocument(ContentInterface, Uri, Uri, Uri) + * @see DocumentsContract#moveDocument(ContentResolver, Uri, Uri, Uri) * @see DocumentsProvider#moveDocument(String, String, String) */ public static final int FLAG_SUPPORTS_MOVE = 1 << 8; @@ -503,7 +502,7 @@ public final class DocumentsContract { * Flag indicating that a document can be removed from a parent. * * @see #COLUMN_FLAGS - * @see DocumentsContract#removeDocument(ContentInterface, Uri, Uri) + * @see DocumentsContract#removeDocument(ContentResolver, Uri, Uri) * @see DocumentsProvider#removeDocument(String, String) */ public static final int FLAG_SUPPORTS_REMOVE = 1 << 10; @@ -539,7 +538,7 @@ public final class DocumentsContract { * using DocumentsContract#getDocumentMetadata * * @see #COLUMN_FLAGS - * @see DocumentsContract#getDocumentMetadata(ContentInterface, Uri) + * @see DocumentsContract#getDocumentMetadata(ContentResolver, Uri) */ public static final int FLAG_SUPPORTS_METADATA = 1 << 14; } @@ -721,7 +720,7 @@ public final class DocumentsContract { * Flag indicating that this root can be ejected. * * @see #COLUMN_FLAGS - * @see DocumentsContract#ejectRoot(ContentInterface, Uri) + * @see DocumentsContract#ejectRoot(ContentResolver, Uri) * @see DocumentsProvider#ejectRoot(String) */ public static final int FLAG_SUPPORTS_EJECT = 1 << 5; diff --git a/core/java/android/telephony/PhoneStateListener.java b/core/java/android/telephony/PhoneStateListener.java index 7267db3b3a1f..d64077525905 100644 --- a/core/java/android/telephony/PhoneStateListener.java +++ b/core/java/android/telephony/PhoneStateListener.java @@ -379,8 +379,6 @@ public class PhoneStateListener { * * <p>Requires permission {@link android.Manifest.permission#READ_PHONE_STATE} or the calling * app has carrier privileges (see {@link TelephonyManager#hasCarrierPrivileges}). - * - * @see #onEmergencyNumberListChanged */ public static final int LISTEN_EMERGENCY_NUMBER_LIST = 0x01000000; @@ -459,7 +457,7 @@ public class PhoneStateListener { * <p>Requires permission {@link android.Manifest.permission#READ_PHONE_STATE} or the calling * app has carrier privileges (see {@link TelephonyManager#hasCarrierPrivileges}). * - * @see #onRegistrationFailed() + * @see #onRegistrationFailed */ @RequiresPermission(Manifest.permission.READ_PHONE_STATE) public static final int LISTEN_REGISTRATION_FAILURE = 0x40000000; @@ -470,7 +468,7 @@ public class PhoneStateListener { * <p>Requires permission {@link android.Manifest.permission#READ_PHONE_STATE} or the calling * app has carrier privileges (see {@link TelephonyManager#hasCarrierPrivileges}). * - * @see #onBarringInfoChanged() + * @see #onBarringInfoChanged */ @RequiresPermission(Manifest.permission.READ_PHONE_STATE) public static final int LISTEN_BARRING_INFO = 0x80000000; diff --git a/core/java/android/text/style/LineBackgroundSpan.java b/core/java/android/text/style/LineBackgroundSpan.java index 7cb91477738e..1dc469d485dc 100644 --- a/core/java/android/text/style/LineBackgroundSpan.java +++ b/core/java/android/text/style/LineBackgroundSpan.java @@ -112,7 +112,7 @@ public interface LineBackgroundSpan extends ParagraphStyle /** * @return the color of this span. - * @see Standard#Standard(int) + * @see Standard#LineBackgroundSpan.Standard(int) */ @ColorInt public final int getColor() { diff --git a/core/java/android/view/WindowManager.java b/core/java/android/view/WindowManager.java index d9d92788a434..859b137dc2ce 100644 --- a/core/java/android/view/WindowManager.java +++ b/core/java/android/view/WindowManager.java @@ -614,7 +614,6 @@ public interface WindowManager extends ViewManager { * @see #TYPE_TOAST * @see #TYPE_SYSTEM_OVERLAY * @see #TYPE_PRIORITY_PHONE - * @see #TYPE_STATUS_BAR_PANEL * @see #TYPE_SYSTEM_DIALOG * @see #TYPE_KEYGUARD_DIALOG * @see #TYPE_SYSTEM_ERROR diff --git a/core/java/android/view/inspector/StaticInspectionCompanionProvider.java b/core/java/android/view/inspector/StaticInspectionCompanionProvider.java index 42a892dedf4d..903fc13a03ea 100644 --- a/core/java/android/view/inspector/StaticInspectionCompanionProvider.java +++ b/core/java/android/view/inspector/StaticInspectionCompanionProvider.java @@ -21,8 +21,6 @@ import android.annotation.Nullable; /** * An inspection companion provider that finds companions as inner classes or generated code. - * - * @see android.processor.view.inspector.PlatformInspectableProcessor */ public class StaticInspectionCompanionProvider implements InspectionCompanionProvider { /** diff --git a/core/java/android/view/textclassifier/ConversationActions.java b/core/java/android/view/textclassifier/ConversationActions.java index 7c527bae475d..b10a598a4b5d 100644 --- a/core/java/android/view/textclassifier/ConversationActions.java +++ b/core/java/android/view/textclassifier/ConversationActions.java @@ -109,7 +109,7 @@ public final class ConversationActions implements Parcelable { /** * Represents the local user. * - * @see Builder#Builder(Person) + * @see Builder#ConversationActions.Message.Builder(Person) */ @NonNull public static final Person PERSON_USER_SELF = @@ -124,7 +124,7 @@ public final class ConversationActions implements Parcelable { * the remote user better, so that the underlying model could differentiate between * different remote users. * - * @see Builder#Builder(Person) + * @see Builder#ConversationActions.Message.Builder(Person) */ @NonNull public static final Person PERSON_USER_OTHERS = |