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

Commit 45717db8 authored by Anton Hansson's avatar Anton Hansson
Browse files

Fix broken documentation in android.view 

The most common problem were references to SystemApi or @hide symbols
from public documentation. Replace such references with natural english
or {@code}. A few references were just incorrect before and have been
fixed.

Bug: 303184203
Test: m docs
Change-Id: I243e27d7ae6e0dafa2af4f3cc44aa7e8894025f1
parent 352e82e4

api/javadoc-lint-baseline

+0 −30
Original line number Diff line number Diff line
@@ -197,33 +197,7 @@ android/service/quickaccesswallet/WalletCard.java:285: lint: Unresolved link/see 
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/InputDevice.java:71: lint: Unresolved link/see tag "InputManagerGlobal.InputDeviceListener" in android.view.InputDevice [101]

android/view/PixelCopy.java:468: lint: Unresolved link/see tag "android.view.PixelCopy.CopyResultStatus CopyResultStatus" in android.view.PixelCopy.Result [101]

android/view/ScrollFeedbackProvider.java:-25: lint: Unresolved link/see tag "InputManager" in android.view.ScrollFeedbackProvider [101]

android/view/ScrollFeedbackProvider.java:-25: lint: Unresolved link/see tag "InputManager#getInputDeviceIds()" in android.view.ScrollFeedbackProvider [101]

android/view/SurfaceControl.java:823: lint: Unresolved link/see tag "android.view.SurfaceControl.TrustedPresentationCallback TrustedPresentationCallback" in android.view.SurfaceControl.Transaction [101]

android/view/SurfaceControl.java:900: lint: Unresolved link/see tag "android.view.SurfaceControl.TrustedPresentationCallback TrustedPresentationCallback" in android.view.SurfaceControl.Transaction [101]

android/view/SurfaceControl.java:908: lint: Unresolved link/see tag "android.view.SurfaceControl.TrustedPresentationCallback TrustedPresentationCallback" in android.view.SurfaceControl.Transaction [101]

android/view/View.java:1647: lint: Unresolved link/see tag "androidx.core.view.ViewCompat#setAccessibilityPaneTitle(View, CharSequence)" in android.view.View [101]

android/view/View.java:4669: lint: Unresolved link/see tag "androidx.core.view.ViewCompat#setScreenReaderFocusable(View, boolean)" in android.view.View [101]

android/view/View.java:4712: lint: Unresolved link/see tag "androidx.core.view.ViewCompat#setAccessibilityHeading(View, boolean)" in android.view.View [101]

android/view/WindowManager.java:230: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowManager [101]

android/view/WindowManager.java:247: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowManager [101]

android/view/WindowManager.java:822: lint: @attr must be a field: android.R.attr#Window_windowNoMoveAnimation [106]

android/view/WindowManager.java:832: lint: @attr must be a field: android.R.attr#Window_windowNoMoveAnimation [106]

android/view/WindowMetrics.java:22: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowMetrics [101]

android/view/WindowMetrics.java:57: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowMetrics [101]

android/view/WindowMetrics.java:114: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowMetrics [101]

android/view/WindowMetrics.java:127: lint: Unresolved link/see tag "android.annotation.UiContext" in android.view.WindowMetrics [101]

android/view/accessibility/AccessibilityNodeInfo.java:368: lint: Unresolved link/see tag "androidx.core.view.ViewCompat#addAccessibilityAction(View, AccessibilityNodeInfoCompat.AccessibilityActionCompat)" in android.view.accessibility.AccessibilityNodeInfo [101]

android/view/accessibility/AccessibilityNodeInfo.java:3246: lint: Unresolved link/see tag "androidx.core.view.ViewCompat#addAccessibilityAction(View, AccessibilityNodeInfoCompat.AccessibilityActionCompat)" in android.view.accessibility.AccessibilityNodeInfo.AccessibilityAction [101]

android/view/displayhash/DisplayHashResultCallback.java:38: lint: Unresolved link/see tag "android.view.displayhash.DisplayHashResultCallback.DisplayHashErrorCode DisplayHashErrorCode" in android.view.displayhash.DisplayHashResultCallback [101]

android/view/inputmethod/EditorInfo.java:107: lint: Unresolved link/see tag "android.widget.Editor Editor" in android.view.inputmethod.EditorInfo [101]

android/view/inputmethod/EditorInfo.java:122: lint: Unresolved link/see tag "android.widget.Editor Editor" in android.view.inputmethod.EditorInfo [101]

android/view/inputmethod/InputMethodManager.java:423: lint: Unresolved link/see tag "android.widget.Editor Editor" in android.view.inputmethod.InputMethodManager [101]

android/view/inputmethod/InputMethodManager.java:447: lint: Unresolved link/see tag "android.widget.Editor Editor" in android.view.inputmethod.InputMethodManager [101]

android/view/inputmethod/InputMethodManager.java:456: lint: Unresolved link/see tag "android.widget.Editor Editor" in android.view.inputmethod.InputMethodManager [101]

android/view/inspector/PropertyReader.java:141: lint: Unresolved link/see tag "android.annotation.ColorInt ColorInt" in android.view.inspector.PropertyReader [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]
@@ -234,8 +208,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 "Callback#onFailure" in android [101]

android/service/voice/AlwaysOnHotwordDetector.java:278: lint: Unresolved link/see tag "Callback#onUnknownFailure" 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/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/server/broadcastradio/aidl/ConversionUtils.java:70: lint: Unresolved link/see tag "IdentifierType#DAB_SID_EXT" in android [101]
@@ -257,7 +229,5 @@ com/android/server/devicepolicy/DevicePolicyManagerService.java:860: lint: Unres 


android/os/BatteryStatsManager.java:260: lint: Invalid tag: @Deprecated [131]

android/os/BatteryStatsManager.java:275: lint: Invalid tag: @Deprecated [131]

android/view/WindowManager.java:906: lint: @attr must be a field: android.R.attr#Window_windowNoMoveAnimation [106]

android/view/WindowManager.java:916: lint: @attr must be a field: android.R.attr#Window_windowNoMoveAnimation [106]



java/lang/ClassLoader.java:853: lint: Unknown tag: @systemProperty [103]

core/java/android/view/InputDevice.java

+2 −1
Original line number Diff line number Diff line
@@ -778,7 +778,8 @@ public final class InputDevice implements Parcelable { 
     * Each gamepad or joystick is given a unique, positive controller number when initially

     * configured by the system. This number may change due to events such as device disconnects /

     * reconnects or user initiated reassignment. Any change in number will trigger an event that

     * can be observed by registering an {@link InputManagerGlobal.InputDeviceListener}.

     * can be observed by registering an

     * {@link android.hardware.input.InputManager.InputDeviceListener}.

     * </p>

     * <p>

     * All input devices which are not gamepads or joysticks will be assigned a controller number

core/java/android/view/ScrollFeedbackProvider.java

+2 −2
Original line number Diff line number Diff line
@@ -17,7 +17,6 @@ 
package android.view;



import android.annotation.FlaggedApi;

import android.annotation.NonNull;

import android.view.flags.Flags;



/**
@@ -43,7 +42,8 @@ import android.view.flags.Flags; 
 * the scroll event. If calling this method in response to a {@link MotionEvent}, use the device ID

 * that is reported by the event, which can be obtained using {@link MotionEvent#getDeviceId()}.

 * Otherwise, use a valid ID that is obtained from {@link InputDevice#getId()}, or from an

 * {@link InputManager} instance ({@link InputManager#getInputDeviceIds()} gives all the valid input

 * {@link android.hardware.input.InputManager} instance

 * ({@link android.hardware.input.InputManager#getInputDeviceIds()} gives all the valid input

 * device IDs).

 *

 * <li><p><b>source</b>: should always be the {@link InputDevice} source that generated the scroll

core/java/android/view/SurfaceControl.java

+3 −5
Original line number Diff line number Diff line
@@ -4266,8 +4266,7 @@ public final class SurfaceControl implements Parcelable { 
         * be somewhat arbitrary, and so there are some somewhat arbitrary decisions in

         * this API as well.

         * <p>

         * @param sc         The {@link SurfaceControl} to set the

         *                   {@link TrustedPresentationCallback} on

         * @param sc         The {@link SurfaceControl} to set the callback on

         * @param thresholds The {@link TrustedPresentationThresholds} that will specify when the to

         *                   invoke the callback.

         * @param executor   The {@link Executor} where the callback will be invoked on.
@@ -4300,10 +4299,9 @@ public final class SurfaceControl implements Parcelable { 
        }



        /**

         * Clears the {@link TrustedPresentationCallback} for a specific {@link SurfaceControl}

         * Clears the callback for a specific {@link SurfaceControl}

         *

         * @param sc The SurfaceControl that the {@link TrustedPresentationCallback} should be

         *           cleared from

         * @param sc The SurfaceControl that the callback should be cleared from

         * @return This transaction

         */

        @NonNull

core/java/android/view/WindowManager.java

+5 −5
Original line number Diff line number Diff line
@@ -1685,7 +1685,7 @@ public interface WindowManager extends ViewManager { 
     * orientation (e.g. with {@link android.app.Activity#setRequestedOrientation(int)}). This

     * listener gives application an opportunity to selectively react to device orientation changes.

     * The newly added listener will be called with current proposed rotation. Note that the context

     * of this window manager instance must be a {@link android.annotation.UiContext}.

     * of this window manager instance must be a {@code UiContext}.

     *

     * @param executor The executor on which callback method will be invoked.

     * @param listener Called when the proposed rotation for the context is being delivered.
@@ -1693,7 +1693,7 @@ public interface WindowManager extends ViewManager { 
     *                 {@link Surface#ROTATION_90}, {@link Surface#ROTATION_180} and

     *                 {@link Surface#ROTATION_270}.

     * @throws UnsupportedOperationException if this method is called on an instance that is not

     *         associated with a {@link android.annotation.UiContext}.

     *         associated with a {@code UiContext}.

     */

    default void addProposedRotationListener(@NonNull @CallbackExecutor Executor executor,

            @NonNull IntConsumer listener) {
@@ -3115,7 +3115,7 @@ public interface WindowManager extends ViewManager { 
        /**

         * Never animate position changes of the window.

         *

         * @see android.R.attr#Window_windowNoMoveAnimation

         * @see android.R.styleable#Window_windowNoMoveAnimation

         * {@hide}

         */

        @UnsupportedAppUsage
@@ -4531,7 +4531,7 @@ public interface WindowManager extends ViewManager { 
         * Set whether animations can be played for position changes on this window. If disabled,

         * the window will move to its new position instantly without animating.

         *

         * @attr ref android.R.attr#Window_windowNoMoveAnimation

         * @attr ref android.R.styleable#Window_windowNoMoveAnimation

         */

        public void setCanPlayMoveAnimation(boolean enable) {

            if (enable) {
@@ -4546,7 +4546,7 @@ public interface WindowManager extends ViewManager { 
         * This does not guarantee that an animation will be played in all such situations. For

         * example, drag-resizing may move the window but not play an animation.

         *

         * @attr ref android.R.attr#Window_windowNoMoveAnimation

         * @attr ref android.R.styleable#Window_windowNoMoveAnimation

         */

        public boolean canPlayMoveAnimation() {

            return (privateFlags & PRIVATE_FLAG_NO_MOVE_ANIMATION) == 0;