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

Commit 8fe35e5f authored by Andrew Sapperstein's avatar Andrew Sapperstein
Browse files

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
Exempt-From-Owner-Approval: cherry-picked from master
Change-Id: Ifbdce2de96cdffa560bd90f549fa7184d1f9af85
Merged-In: Ifbdce2de96cdffa560bd90f549fa7184d1f9af85
(cherry picked from commit e0624c7a)
parent bf8d4b44

apex/blobstore/framework/java/android/app/blob/BlobStoreManager.java

+8 −8
Original line number Diff line number Diff line
@@ -307,8 +307,8 @@ public class BlobStoreManager { 
     *                                {@link #getRemainingLeaseQuotaBytes()} before trying to

     *                                acquire a lease.

     *

     * @see {@link #acquireLease(BlobHandle, int)}

     * @see {@link #acquireLease(BlobHandle, CharSequence)}

     * @see #acquireLease(BlobHandle, int)

     * @see #acquireLease(BlobHandle, CharSequence)

     */

    public void acquireLease(@NonNull BlobHandle blobHandle, @IdRes int descriptionResId,

            @CurrentTimeMillisLong long leaseExpiryTimeMillis) throws IOException {
@@ -367,8 +367,8 @@ public class BlobStoreManager { 
     *                                {@link #getRemainingLeaseQuotaBytes()} before trying to

     *                                acquire a lease.

     *

     * @see {@link #acquireLease(BlobHandle, int, long)}

     * @see {@link #acquireLease(BlobHandle, CharSequence)}

     * @see #acquireLease(BlobHandle, int, long)

     * @see #acquireLease(BlobHandle, CharSequence)

     */

    public void acquireLease(@NonNull BlobHandle blobHandle, @NonNull CharSequence description,

            @CurrentTimeMillisLong long leaseExpiryTimeMillis) throws IOException {
@@ -420,8 +420,8 @@ public class BlobStoreManager { 
     *                                {@link #getRemainingLeaseQuotaBytes()} before trying to

     *                                acquire a lease.

     *

     * @see {@link #acquireLease(BlobHandle, int, long)}

     * @see {@link #acquireLease(BlobHandle, CharSequence, long)}

     * @see #acquireLease(BlobHandle, int, long)

     * @see #acquireLease(BlobHandle, CharSequence, long)

     */

    public void acquireLease(@NonNull BlobHandle blobHandle, @IdRes int descriptionResId)

            throws IOException {
@@ -467,8 +467,8 @@ public class BlobStoreManager { 
     *                                {@link #getRemainingLeaseQuotaBytes()} before trying to

     *                                acquire a lease.

     *

     * @see {@link #acquireLease(BlobHandle, int)}

     * @see {@link #acquireLease(BlobHandle, CharSequence, long)}

     * @see #acquireLease(BlobHandle, int)

     * @see #acquireLease(BlobHandle, CharSequence, long)

     */

    public void acquireLease(@NonNull BlobHandle blobHandle, @NonNull CharSequence description)

            throws IOException {

core/java/android/app/Activity.java

+0 −1
Original line number Diff line number Diff line
@@ -3743,7 +3743,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) {

core/java/android/app/ActivityManager.java

+1 −2
Original line number Diff line number Diff line
@@ -2450,8 +2450,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.

core/java/android/app/AppOpsManager.java

+0 −6
Original line number Diff line number Diff line
@@ -6858,10 +6858,7 @@ public class AppOpsManager { 
     * @param ops The operations to watch.

     * @param callback Where to report changes.

     *

     * @see #isOperationActive

     * @see #stopWatchingActive

     * @see #startOp(int, int, String, boolean, String, String)

     * @see #finishOp(int, int, String, String)

     */

    // TODO: Uncomment below annotation once b/73559440 is fixed

    // @RequiresPermission(value=Manifest.permission.WATCH_APPOPS, conditional=true)
@@ -6909,10 +6906,7 @@ public class AppOpsManager { 
     * long running and it has a clear start and stop delimiters. Unregistering a

     * non-registered callback has no effect.

     *

     * @see #isOperationActive

     * @see #startWatchingActive

     * @see #startOp(int, int, String, boolean, String, String)

     * @see #finishOp(int, int, String, String)

     */

    public void stopWatchingActive(@NonNull OnOpActiveChangedListener callback) {

        synchronized (mActiveWatchers) {

core/java/android/app/Notification.java

+2 −2
Original line number Diff line number Diff line
@@ -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#Builder(String)

         * @see Notification.BubbleMetadata.Builder#Notification.BubbleMetadata.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#Builder(String)

         * @see Notification.BubbleMetadata.Builder#Notification.BubbleMetadata.Builder(String)

         * @see #setShortcutId(String)

         */

        @NonNull