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 4c4aa41272)
This commit is contained in:
Andrew Sapperstein
2020-04-29 13:16:02 -07:00
parent 8fe35e5f21
commit 88d565e7e7
15 changed files with 31 additions and 31 deletions

View File

@@ -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)}.
* </p>
* <p>
* 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);

View File

@@ -732,7 +732,7 @@ public class Instrumentation {
* a non-null value if the intent needs to be intercepted.
*
* <p> 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.

View File

@@ -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 <code>null</code> 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
*/

View File

@@ -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

View File

@@ -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) {

View File

@@ -719,7 +719,7 @@ public final class SaveInfo implements Parcelable {
*
* <p>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
*/

View File

@@ -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() {

View File

@@ -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.
*

View File

@@ -5120,7 +5120,7 @@ public class AccessibilityNodeInfo implements Parcelable {
* Obtains a pooled instance that is a clone of another one.
*
* <p>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.
*
* <p>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 {
*
* <p>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 {
*
* <p>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 {
*
* <p>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 {
*
* <p>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 {
*
* <p>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 {
*
* <p>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.

View File

@@ -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 =

View File

@@ -80,9 +80,9 @@ import android.os.Looper;
* <p>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)}.
*
* <h3>Qualifying your focus request</h3>
* <h4>Use case requiring a focus request</h4>

View File

@@ -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;

View File

@@ -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() {

View File

@@ -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)
*/

View File

@@ -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() {