From 1dc3ac9b80298d53df909ae781a61bea6b51c8ac Mon Sep 17 00:00:00 2001 From: Anton Hansson Date: Thu, 12 Oct 2023 13:17:27 +0000 Subject: Fix broken docs in companion - Remove @links to SystemApi - Escape @-symbols Bug: 303184203 Test: m docs Change-Id: Iafaaa2150d36cf36dadfefaa29f56e0dd0d756d9 --- api/javadoc-lint-baseline | 9 --------- core/java/android/companion/CompanionDeviceService.java | 12 ++++++------ core/java/android/companion/virtual/VirtualDevice.java | 5 ----- .../virtual/sensor/VirtualSensorDirectChannelWriter.java | 6 +++--- .../android/server/companion/virtual/VirtualDeviceImpl.java | 6 +++--- 5 files changed, 12 insertions(+), 26 deletions(-) diff --git a/api/javadoc-lint-baseline b/api/javadoc-lint-baseline index 2cc5078c8844..49f4d1f6d2b8 100644 --- a/api/javadoc-lint-baseline +++ b/api/javadoc-lint-baseline @@ -86,10 +86,6 @@ android/app/appsearch/SearchSpec.java:929: lint: Unresolved link/see tag "Featur android/app/job/JobParameters.java:128: lint: Unresolved link/see tag "android.app.job.JobInfo.Builder#setPeriodic(boolean) periodic jobs" in android.app.job.JobParameters [101] android/app/sdksandbox/AppOwnedSdkSandboxInterface.java:9: lint: Unresolved link/see tag "SdkSandboxController#getAppOwnedSdkSandboxInterfaces" in android.app.sdksandbox.AppOwnedSdkSandboxInterface [101] android/app/sdksandbox/SdkSandboxManager.java:112: lint: Unresolved link/see tag "AppOwnedSdkSandboxInterfaces" in android.app.sdksandbox.SdkSandboxManager [101] -android/companion/CompanionDeviceService.java:273: lint: Unresolved link/see tag "android.companion.AssociationInfo#isSelfManaged() self-managed" in android.companion.CompanionDeviceService [101] -android/companion/CompanionDeviceService.java:282: lint: Unresolved link/see tag "android.companion.AssociationInfo#isSelfManaged() self-managed" in android.companion.CompanionDeviceService [101] -android/companion/virtual/VirtualDevice.java:15: lint: Unresolved link/see tag "android.companion.virtual.VirtualDeviceManager.VirtualDevice VirtualDeviceManager.VirtualDevice" in android.companion.virtual.VirtualDevice [101] -android/companion/virtual/VirtualDevice.java:70: lint: Unresolved link/see tag "android.companion.virtual.VirtualDeviceParams.Builder#setName(String)" in android.companion.virtual.VirtualDevice [101] android/content/AttributionSource.java:291: lint: Unresolved link/see tag "setNextAttributionSource" in android.content.AttributionSource.Builder [101] android/content/Context.java:2872: lint: Unresolved link/see tag "android.telephony.MmsManager" in android.content.Context [101] android/content/Intent.java:4734: lint: Unresolved link/see tag "android.content.pm.UserInfo#isProfile()" in android.content.Intent [101] @@ -273,8 +269,6 @@ android/view/animation/AnimationUtils.java:64: lint: Unresolved link/see tag "Bu 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/companion/virtual/VirtualDeviceImpl.java:134: lint: Unresolved link/see tag "DisplayManager" in android [101] -com/android/server/companion/virtual/VirtualDeviceImpl.java:134: lint: Unresolved link/see tag "VirtualDeviceManager.VirtualDevice" in android [101] com/android/server/broadcastradio/aidl/ConversionUtils.java:70: lint: Unresolved link/see tag "IdentifierType#DAB_SID_EXT" in android [101] com/android/server/broadcastradio/aidl/ConversionUtils.java:70: lint: Unresolved link/see tag "ProgramSelector#IDENTIFIER_TYPE_DAB_DMB_SID_EXT" in android [101] com/android/server/broadcastradio/aidl/ConversionUtils.java:70: lint: Unresolved link/see tag "RadioTuner" in android [101] @@ -292,9 +286,6 @@ com/android/server/pm/PackageInstallerSession.java:327: lint: Unresolved link/se com/android/server/pm/PackageInstallerSession.java:358: lint: Unresolved link/see tag "IntentSender" in android [101] com/android/server/devicepolicy/DevicePolicyManagerService.java:860: lint: Unresolved link/see tag "android.security.IKeyChainService#setGrant" in android [101] -android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-4: lint: Invalid tag: @Override [131] -android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:-1: lint: Invalid tag: @Override [131] -android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java:2: lint: Invalid tag: @Override [131] 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] diff --git a/core/java/android/companion/CompanionDeviceService.java b/core/java/android/companion/CompanionDeviceService.java index 03e75e9fc483..570ecaa47b4e 100644 --- a/core/java/android/companion/CompanionDeviceService.java +++ b/core/java/android/companion/CompanionDeviceService.java @@ -161,16 +161,16 @@ public abstract class CompanionDeviceService extends Service { public static final int DEVICE_EVENT_BT_DISCONNECTED = 3; /** - * A companion app for a {@link AssociationInfo#isSelfManaged() self-managed} device will - * receive the callback {@link #onDeviceEvent(AssociationInfo, int)} if it reports that a - * device has appeared on its own. + * A companion app for a self-managed device will receive the callback + * {@link #onDeviceEvent(AssociationInfo, int)} if it reports that a device has appeared on its + * own. */ public static final int DEVICE_EVENT_SELF_MANAGED_APPEARED = 4; /** - * A companion app for a {@link AssociationInfo#isSelfManaged() self-managed} device will - * receive the callback {@link #onDeviceEvent(AssociationInfo, int)} if it reports that a - * device has disappeared on its own. + * A companion app for a self-managed device will receive the callback + * {@link #onDeviceEvent(AssociationInfo, int)} if it reports that a device has disappeared on + * its own. */ public static final int DEVICE_EVENT_SELF_MANAGED_DISAPPEARED = 5; diff --git a/core/java/android/companion/virtual/VirtualDevice.java b/core/java/android/companion/virtual/VirtualDevice.java index 0af4c92e0b63..93a3e7822888 100644 --- a/core/java/android/companion/virtual/VirtualDevice.java +++ b/core/java/android/companion/virtual/VirtualDevice.java @@ -33,9 +33,6 @@ import android.os.RemoteException; * *

Read-only device representation exposing the properties of an existing virtual device. * - *

Not to be confused with {@link VirtualDeviceManager.VirtualDevice}, which is used - * by the virtual device creator and allows them to manage the device. - * * @see VirtualDeviceManager#registerVirtualDeviceListener */ public final class VirtualDevice implements Parcelable { @@ -120,8 +117,6 @@ public final class VirtualDevice implements Parcelable { /** * Returns the name of the virtual device (optionally) provided during its creation. - * - * @see VirtualDeviceParams.Builder#setName(String) */ public @Nullable String getName() { return mName; diff --git a/core/java/android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java b/core/java/android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java index bf78dd09e7c2..b9451a74f9e9 100644 --- a/core/java/android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java +++ b/core/java/android/companion/virtual/sensor/VirtualSensorDirectChannelWriter.java @@ -46,15 +46,15 @@ import java.util.concurrent.atomic.AtomicLong; * 

  * VirtualSensorDirectChannelWriter writer = new VirtualSensorDirectChannelWriter();
  * VirtualSensorDirectChannelCallback callback = new VirtualSensorDirectChannelCallback() {
- *     @Override
+ *     {@literal @}Override
  *     public void onDirectChannelCreated(int channelHandle, SharedMemory sharedMemory) {
  *         writer.addChannel(channelHandle, sharedMemory);
  *     }
- *     @Override
+ *     {@literal @}Override
  *     public void onDirectChannelDestroyed(int channelHandle);
  *         writer.removeChannel(channelHandle);
  *     }
- *     @Override
+ *     {@literal @}Override
  *     public void onDirectChannelConfigured(int channelHandle, VirtualSensor sensor, int rateLevel,
  *             int reportToken)
  *         if (!writer.configureChannel(channelHandle, sensor, rateLevel, reportToken)) {
diff --git a/services/companion/java/com/android/server/companion/virtual/VirtualDeviceImpl.java b/services/companion/java/com/android/server/companion/virtual/VirtualDeviceImpl.java
index 8a2aa616f8e6..f5562d27f4e8 100644
--- a/services/companion/java/com/android/server/companion/virtual/VirtualDeviceImpl.java
+++ b/services/companion/java/com/android/server/companion/virtual/VirtualDeviceImpl.java
@@ -122,9 +122,9 @@ final class VirtualDeviceImpl extends IVirtualDevice.Stub
     private static final String TAG = "VirtualDeviceImpl";
 
     /**
-     * Virtual displays created by a {@link VirtualDeviceManager.VirtualDevice} are more consistent
-     * with virtual displays created via {@link DisplayManager} and allow for the creation of
-     * private, auto-mirror, and fixed orientation displays since
+     * Virtual displays created by a {@code VirtualDeviceManager.VirtualDevice} are more consistent
+     * with virtual displays created via {@link android.hardware.display.DisplayManager} and allow
+     * for the creation of private, auto-mirror, and fixed orientation displays since
      * {@link android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM}.
      *
      * @see DisplayManager#VIRTUAL_DISPLAY_FLAG_PUBLIC
-- 
cgit v1.2.3-59-g8ed1b