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

Commit 1f6e22cb authored Apr 28, 2020 by Andrew Sapperstein

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

parent da820447

core/java/android/app/Activity.java

+0 −1

Original line number	Original line	Diff line number	Diff line
	@@ -3618,7 +3618,6 @@ public class Activity extends ContextThemeWrapper
	* To receive this callback, you must return true from onKeyDown for the current		* To receive this callback, you must return true from onKeyDown for the current
	* event stream.		* event stream.
	*		*
	* @see KeyEvent.Callback#onKeyLongPress()
	* @see KeyEvent.Callback#onKeyLongPress(int, KeyEvent)		* @see KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
	*/		*/
	public boolean onKeyLongPress(int keyCode, KeyEvent event) {		public boolean onKeyLongPress(int keyCode, KeyEvent event) {

core/java/android/app/ActivityManager.java

+1 −2

Original line number	Original line	Diff line number	Diff line
	@@ -2082,8 +2082,7 @@ public class ActivityManager {
	* has access to it.		* has access to it.
	*		*
	* @see ActivityOptions#setLaunchDisplayId(int)		* @see ActivityOptions#setLaunchDisplayId(int)
	* @see android.view.Display.FLAG_PRIVATE		* @see android.view.Display#FLAG_PRIVATE
	* @see android.view.Display.TYPE_VIRTUAL
	*		*
	* @param context Source context, from which an activity will be started.		* @param context Source context, from which an activity will be started.
	* @param displayId Target display id.		* @param displayId Target display id.

core/java/android/app/NotificationManager.java

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -294,7 +294,7 @@ public class NotificationManager {
	* </p>		* </p>
	* </p>		* </p>
	*		*
	* @see {@link #addAutomaticZenRule(AutomaticZenRule)}		* @see #addAutomaticZenRule(AutomaticZenRule)
	*/		*/
	@SdkConstant(SdkConstant.SdkConstantType.ACTIVITY_INTENT_ACTION)		@SdkConstant(SdkConstant.SdkConstantType.ACTIVITY_INTENT_ACTION)
	public static final String ACTION_AUTOMATIC_ZEN_RULE =		public static final String ACTION_AUTOMATIC_ZEN_RULE =

core/java/android/app/backup/BackupManager.java

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -803,7 +803,7 @@ public class BackupManager {
	* has a work profile that was restored from another work profile with serial number		* has a work profile that was restored from another work profile with serial number
	* {@code ancestralSerialNumber}.		* {@code ancestralSerialNumber}.
	*		*
	* @see UserManager#getSerialNumberForUser(UserHandle)		* @see android.os.UserManager#getSerialNumberForUser(UserHandle)
	*/		*/
	@Nullable		@Nullable
	public UserHandle getUserForAncestralSerialNumber(long ancestralSerialNumber) {		public UserHandle getUserForAncestralSerialNumber(long ancestralSerialNumber) {

core/java/android/app/role/RoleManager.java

+0 −2

Original line number	Original line	Diff line number	Diff line
	@@ -102,8 +102,6 @@ public final class RoleManager {

	/**		/**
	* The name of the emergency role		* The name of the emergency role
	*
	* @see android.telephony.TelephonyManager#ACTION_EMERGENCY_ASSISTANCE
	*/		*/
	public static final String ROLE_EMERGENCY = "android.app.role.EMERGENCY";		public static final String ROLE_EMERGENCY = "android.app.role.EMERGENCY";