From 88d565e7e73ff2f404a07fcc477132ed4547ce0b Mon Sep 17 00:00:00 2001 From: Andrew Sapperstein Date: Wed, 29 Apr 2020 13:16:02 -0700 Subject: [PATCH] Update inner class constructor refs to use proper syntax. Previously, we generally required fully qualified names for referring to inner class constructors (like #Notification.Builder()) despite that not being valid javadoc. Now, we properly support #Builder() syntax and the old syntax will error. Bug: 6963924 Test: make doc-comment-check-docs Exempt-From-Owner-Approval: cherry-picked from master Change-Id: Ib2e4360493275b79c72487ee1cb173bb5e0fd35f Merged-In: Ib2e4360493275b79c72487ee1cb173bb5e0fd35f (cherry picked from commit 4c4aa41272b431f603e401f49464ee776b55d8f5) --- .../java/android/app/job/JobScheduler.java | 4 ++-- core/java/android/app/Instrumentation.java | 2 +- core/java/android/app/Notification.java | 10 +++++----- .../service/autofill/CustomDescription.java | 2 +- .../service/autofill/ImageTransformation.java | 2 +- core/java/android/service/autofill/SaveInfo.java | 4 ++-- .../android/text/style/LineBackgroundSpan.java | 2 +- core/java/android/view/View.java | 4 ++-- .../accessibility/AccessibilityNodeInfo.java | 16 ++++++++-------- .../view/textclassifier/ConversationActions.java | 4 ++-- media/java/android/media/AudioFocusRequest.java | 4 ++-- .../media/AudioPlaybackCaptureConfiguration.java | 2 +- media/java/android/media/MediaRoute2Info.java | 2 +- .../media/MediaRoute2ProviderService.java | 2 +- media/java/android/media/RoutingSessionInfo.java | 2 +- 15 files changed, 31 insertions(+), 31 deletions(-) diff --git a/apex/jobscheduler/framework/java/android/app/job/JobScheduler.java b/apex/jobscheduler/framework/java/android/app/job/JobScheduler.java index abf78c67fa6ff..231263579088f 100644 --- a/apex/jobscheduler/framework/java/android/app/job/JobScheduler.java +++ b/apex/jobscheduler/framework/java/android/app/job/JobScheduler.java @@ -41,7 +41,7 @@ import java.util.List; * system will execute this job on your application's {@link android.app.job.JobService}. * You identify the service component that implements the logic for your job when you * construct the JobInfo using - * {@link android.app.job.JobInfo.Builder#JobInfo.Builder(int,android.content.ComponentName)}. + * {@link android.app.job.JobInfo.Builder#Builder(int,android.content.ComponentName)}. *

*

* The framework will be intelligent about when it executes jobs, and attempt to batch @@ -153,7 +153,7 @@ public abstract class JobScheduler { * method is ignored. * * @param jobId unique identifier for the job to be canceled, as supplied to - * {@link JobInfo.Builder#JobInfo.Builder(int, android.content.ComponentName) + * {@link JobInfo.Builder#Builder(int, android.content.ComponentName) * JobInfo.Builder(int, android.content.ComponentName)}. */ public abstract void cancel(int jobId); diff --git a/core/java/android/app/Instrumentation.java b/core/java/android/app/Instrumentation.java index 818a121459327..e233adeb3f65a 100644 --- a/core/java/android/app/Instrumentation.java +++ b/core/java/android/app/Instrumentation.java @@ -732,7 +732,7 @@ public class Instrumentation { * a non-null value if the intent needs to be intercepted. * *

Whenever a new activity is started, this method will be called on instances created - * using {@link #Instrumentation.ActivityMonitor()} to check if there is a match. In case + * using {@link #ActivityMonitor()} to check if there is a match. In case * of a match, the activity start will be blocked and the returned result will be used. * * @param intent The intent used for starting the activity. diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java index 2a5839c959d92..a033b82f48cd1 100644 --- a/core/java/android/app/Notification.java +++ b/core/java/android/app/Notification.java @@ -3513,7 +3513,7 @@ public class Notification implements Parcelable } /** - * @deprecated use {@link Notification.Builder#Notification.Builder(Context, String)} + * @deprecated use {@link #Builder(Context, String)} * instead. All posted Notifications must specify a NotificationChannel Id. */ @Deprecated @@ -3631,7 +3631,7 @@ public class Notification implements Parcelable * @param shortcutId the {@link ShortcutInfo#getId() id} of the shortcut this notification * is linked to * - * @see Notification.BubbleMetadata.Builder#Notification.BubbleMetadata.Builder(String) + * @see BubbleMetadata.Builder#Builder(String) */ @NonNull public Builder setShortcutId(String shortcutId) { @@ -5993,7 +5993,7 @@ public class Notification implements Parcelable * metadata matches the shortcutId set on the notification builder, if one was set. * If the shortcutId's were specified but do not match, an exception is thrown here. * - * @see Notification.BubbleMetadata.Builder#Notification.BubbleMetadata.Builder(String) + * @see BubbleMetadata.Builder#Builder(String) * @see #setShortcutId(String) */ @NonNull @@ -7297,7 +7297,7 @@ public class Notification implements Parcelable * Should be unique amongst all individuals in the conversation, and should be * consistent during re-posts of the notification. * - * @see Message#Notification.MessagingStyle.Message(CharSequence, long, CharSequence) + * @see Message#Message(CharSequence, long, CharSequence) * * @return this object for method chaining * @@ -7317,7 +7317,7 @@ public class Notification implements Parcelable * Should be null for messages by the current user, in which case * the platform will insert the user set in {@code MessagingStyle(Person)}. * - * @see Message#Notification.MessagingStyle.Message(CharSequence, long, CharSequence) + * @see Message#Message(CharSequence, long, CharSequence) * * @return this object for method chaining */ diff --git a/core/java/android/service/autofill/CustomDescription.java b/core/java/android/service/autofill/CustomDescription.java index c28d2bbe30ea6..e274460cdf037 100644 --- a/core/java/android/service/autofill/CustomDescription.java +++ b/core/java/android/service/autofill/CustomDescription.java @@ -262,7 +262,7 @@ public final class CustomDescription implements Parcelable { * * @param condition condition used to trigger the updates. * @param updates actions to be applied to the - * {@link #CustomDescription.Builder(RemoteViews) template presentation} when the condition + * {@link #Builder(RemoteViews) template presentation} when the condition * is satisfied. * * @return this builder diff --git a/core/java/android/service/autofill/ImageTransformation.java b/core/java/android/service/autofill/ImageTransformation.java index 12376e85e63e2..974f0ead9d192 100644 --- a/core/java/android/service/autofill/ImageTransformation.java +++ b/core/java/android/service/autofill/ImageTransformation.java @@ -123,7 +123,7 @@ public final class ImageTransformation extends InternalTransformation implements * {@link RemoteViews presentation} must contain a {@link ImageView} child with that id. * * @deprecated use - * {@link #ImageTransformation.Builder(AutofillId, Pattern, int, CharSequence)} instead. + * {@link #Builder(AutofillId, Pattern, int, CharSequence)} instead. */ @Deprecated public Builder(@NonNull AutofillId id, @NonNull Pattern regex, @DrawableRes int resId) { diff --git a/core/java/android/service/autofill/SaveInfo.java b/core/java/android/service/autofill/SaveInfo.java index 4df43628b5d3d..e640eecc03c0d 100644 --- a/core/java/android/service/autofill/SaveInfo.java +++ b/core/java/android/service/autofill/SaveInfo.java @@ -719,7 +719,7 @@ public final class SaveInfo implements Parcelable { * *

The sanitizer can also be used as an alternative for a * {@link #setValidator(Validator) validator}. If any of the {@code ids} is a - * {@link #SaveInfo.Builder(int, AutofillId[]) required id} and the {@code sanitizer} fails + * {@link #Builder(int, AutofillId[]) required id} and the {@code sanitizer} fails * because of it, then the save UI is not shown. * * @param sanitizer an implementation provided by the Android System. @@ -777,7 +777,7 @@ public final class SaveInfo implements Parcelable { * Builds a new {@link SaveInfo} instance. * * @throws IllegalStateException if no - * {@link #SaveInfo.Builder(int, AutofillId[]) required ids}, + * {@link #Builder(int, AutofillId[]) required ids}, * or {@link #setOptionalIds(AutofillId[]) optional ids}, or {@link #FLAG_DELAY_SAVE} * were set */ diff --git a/core/java/android/text/style/LineBackgroundSpan.java b/core/java/android/text/style/LineBackgroundSpan.java index 1dc469d485dcd..7cb91477738e6 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#LineBackgroundSpan.Standard(int) + * @see Standard#Standard(int) */ @ColorInt public final int getColor() { diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java index 310299910e960..ddbff42c5bce4 100644 --- a/core/java/android/view/View.java +++ b/core/java/android/view/View.java @@ -26175,9 +26175,9 @@ public class View implements Drawable.Callback, KeyEvent.Callback, /** * Returns the View object that had been passed to the - * {@link #View.DragShadowBuilder(View)} + * {@link #DragShadowBuilder(View)} * constructor. If that View parameter was {@code null} or if the - * {@link #View.DragShadowBuilder()} + * {@link #DragShadowBuilder()} * constructor was used to instantiate the builder object, this method will return * null. * diff --git a/core/java/android/view/accessibility/AccessibilityNodeInfo.java b/core/java/android/view/accessibility/AccessibilityNodeInfo.java index 6646c3188fc73..eaaaa80f65ed8 100644 --- a/core/java/android/view/accessibility/AccessibilityNodeInfo.java +++ b/core/java/android/view/accessibility/AccessibilityNodeInfo.java @@ -5120,7 +5120,7 @@ public class AccessibilityNodeInfo implements Parcelable { * Obtains a pooled instance that is a clone of another one. * *

In most situations object pooling is not beneficial. Create a new instance using the - * constructor {@link AccessibilityNodeInfo.RangeInfo#AccessibilityNodeInfo.RangeInfo(int, + * constructor {@link AccessibilityNodeInfo.RangeInfo#RangeInfo(int, * float, float, float)} instead. * * @param other The instance to clone. @@ -5135,7 +5135,7 @@ public class AccessibilityNodeInfo implements Parcelable { * Obtains a pooled instance. * *

In most situations object pooling is not beneficial. Create a new instance using the - * constructor {@link AccessibilityNodeInfo.RangeInfo#AccessibilityNodeInfo.RangeInfo(int, + * constructor {@link AccessibilityNodeInfo.RangeInfo#RangeInfo(int, * float, float, float)} instead. * * @param type The type of the range. @@ -5271,7 +5271,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Create a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionInfo#AccessibilityNodeInfo.CollectionInfo} instead. + * AccessibilityNodeInfo.CollectionInfo#CollectionInfo} instead. * * @param other The instance to clone. * @hide @@ -5286,7 +5286,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Create a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionInfo#AccessibilityNodeInfo.CollectionInfo(int, int, + * AccessibilityNodeInfo.CollectionInfo#CollectionInfo(int, int, * boolean)} instead. * * @param rowCount The number of rows, or -1 if count is unknown. @@ -5303,7 +5303,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Create a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionInfo#AccessibilityNodeInfo.CollectionInfo(int, int, + * AccessibilityNodeInfo.CollectionInfo#CollectionInfo(int, int, * boolean, int)} instead. * * @param rowCount The number of rows. @@ -5440,7 +5440,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Create a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionItemInfo#AccessibilityNodeInfo.CollectionItemInfo} + * AccessibilityNodeInfo.CollectionItemInfo#CollectionItemInfo} * instead. * * @param other The instance to clone. @@ -5456,7 +5456,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Create a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionItemInfo#AccessibilityNodeInfo.CollectionItemInfo(int, + * AccessibilityNodeInfo.CollectionItemInfo#CollectionItemInfo(int, * int, int, int, boolean)} instead. * * @param rowIndex The row index at which the item is located. @@ -5476,7 +5476,7 @@ public class AccessibilityNodeInfo implements Parcelable { * *

In most situations object pooling is not beneficial. Creates a new instance using the * constructor {@link - * AccessibilityNodeInfo.CollectionItemInfo#AccessibilityNodeInfo.CollectionItemInfo(int, + * AccessibilityNodeInfo.CollectionItemInfo#CollectionItemInfo(int, * int, int, int, boolean, boolean)} instead. * * @param rowIndex The row index at which the item is located. diff --git a/core/java/android/view/textclassifier/ConversationActions.java b/core/java/android/view/textclassifier/ConversationActions.java index 0b76c61130ad0..6ad5cb9135532 100644 --- a/core/java/android/view/textclassifier/ConversationActions.java +++ b/core/java/android/view/textclassifier/ConversationActions.java @@ -105,7 +105,7 @@ public final class ConversationActions implements Parcelable { /** * Represents the local user. * - * @see Builder#ConversationActions.Message.Builder(Person) + * @see Builder#Builder(Person) */ @NonNull public static final Person PERSON_USER_SELF = @@ -120,7 +120,7 @@ public final class ConversationActions implements Parcelable { * the remote user better, so that the underlying model could differentiate between * different remote users. * - * @see Builder#ConversationActions.Message.Builder(Person) + * @see Builder#Builder(Person) */ @NonNull public static final Person PERSON_USER_OTHERS = diff --git a/media/java/android/media/AudioFocusRequest.java b/media/java/android/media/AudioFocusRequest.java index 4e70501290585..4c0850b675a82 100644 --- a/media/java/android/media/AudioFocusRequest.java +++ b/media/java/android/media/AudioFocusRequest.java @@ -80,9 +80,9 @@ import android.os.Looper; *

An {@code AudioFocusRequest} instance always contains one of the four types of requests * explained above. It is passed when building an {@code AudioFocusRequest} instance with its * builder in the {@link Builder} constructor - * {@link AudioFocusRequest.Builder#AudioFocusRequest.Builder(int)}, or + * {@link AudioFocusRequest.Builder#Builder(int)}, or * with {@link AudioFocusRequest.Builder#setFocusGain(int)} after copying an existing instance with - * {@link AudioFocusRequest.Builder#AudioFocusRequest.Builder(AudioFocusRequest)}. + * {@link AudioFocusRequest.Builder#Builder(AudioFocusRequest)}. * *

Qualifying your focus request

*

Use case requiring a focus request

diff --git a/media/java/android/media/AudioPlaybackCaptureConfiguration.java b/media/java/android/media/AudioPlaybackCaptureConfiguration.java index 895846a292584..453704eea3986 100644 --- a/media/java/android/media/AudioPlaybackCaptureConfiguration.java +++ b/media/java/android/media/AudioPlaybackCaptureConfiguration.java @@ -83,7 +83,7 @@ public final class AudioPlaybackCaptureConfiguration { /** * @return the {@code MediaProjection} used to build this object. - * @see Builder#AudioPlaybackCaptureConfiguration.Builder(MediaProjection) + * @see Builder#Builder(MediaProjection) */ public @NonNull MediaProjection getMediaProjection() { return mProjection; diff --git a/media/java/android/media/MediaRoute2Info.java b/media/java/android/media/MediaRoute2Info.java index 58a39bd1a71eb..e5ad569bb24f4 100644 --- a/media/java/android/media/MediaRoute2Info.java +++ b/media/java/android/media/MediaRoute2Info.java @@ -364,7 +364,7 @@ public final class MediaRoute2Info implements Parcelable { * In order to ensure uniqueness in {@link MediaRouter2} side, the value of this method * can be different from what was set in {@link MediaRoute2ProviderService}. * - * @see Builder#MediaRoute2Info.Builder(String, CharSequence) + * @see Builder#Builder(String, CharSequence) */ @NonNull public String getId() { diff --git a/media/java/android/media/MediaRoute2ProviderService.java b/media/java/android/media/MediaRoute2ProviderService.java index 6b9a00e2180ef..72162c44ec292 100644 --- a/media/java/android/media/MediaRoute2ProviderService.java +++ b/media/java/android/media/MediaRoute2ProviderService.java @@ -356,7 +356,7 @@ public abstract class MediaRoute2ProviderService extends Service { * {@link MediaRouter2}, or null if none. The contents of this bundle * may affect the result of session creation. * - * @see RoutingSessionInfo.Builder#RoutingSessionInfo.Builder(String, String) + * @see RoutingSessionInfo.Builder#Builder(String, String) * @see RoutingSessionInfo.Builder#addSelectedRoute(String) * @see RoutingSessionInfo.Builder#setControlHints(Bundle) */ diff --git a/media/java/android/media/RoutingSessionInfo.java b/media/java/android/media/RoutingSessionInfo.java index 4066065869dc4..608e29a7a6ca3 100644 --- a/media/java/android/media/RoutingSessionInfo.java +++ b/media/java/android/media/RoutingSessionInfo.java @@ -130,7 +130,7 @@ public final class RoutingSessionInfo implements Parcelable { * In order to ensure uniqueness in {@link MediaRouter2} side, the value of this method * can be different from what was set in {@link MediaRoute2ProviderService}. * - * @see Builder#RoutingSessionInfo.Builder(String, String) + * @see Builder#Builder(String, String) */ @NonNull public String getId() {