Improve javadoc for DynamicSystemClient

This class is part of system API. Per API review, there are some
defects in its javadoc. Upload this CL to fix them.

Bug: 126613281
Bug: 128970107
Test: Read the javadoc
Change-Id: I664e11b3833e9c46432badf9f7c5d9ef2cea4ba8

1 files changed, 12 insertions, 11 deletions

diff --git a/core/java/android/os/image/DynamicSystemClient.java b/core/java/android/os/image/DynamicSystemClient.java
index 4eca8fe96353..69599606fa17 100644
--- a/core/java/android/os/image/DynamicSystemClient.java
+++ b/core/java/android/os/image/DynamicSystemClient.java
@@ -46,20 +46,21 @@ import java.util.concurrent.Executor;
  * <p>This class contains methods and constants used to start a {@code DynamicSystem} installation,
  * and a listener for status updates.</p>
  *
- * <p>{@code DynamicSystem} allows user to run certified system images in a non destructive manner
- * without needing to prior OEM unlock. While running in {@code DynamicSystem}, persitent storage
- * for factory reset protection (FRP) remains unchanged. The new system is installed in a
- * temporarily allocated partition. After the installation is completed, the device will be running
- * in the new system on next reboot. Then, when the user reboots the device again, it will leave
- * {@code DynamicSystem} and go back into the original system. Since the userdata for
- * {@code DynamicSystem} is also newly created during the installation, running in
- * {@code DynamicSystem} doesn't change user's app data.</p>
+ * <p>{@code DynamicSystem} allows users to run certified system images in a non destructive manner
+ * without needing to prior OEM unlock. It creates a temporary system partition to install the new
+ * system image, and a temporary data partition for the newly installed system to run with.</p>
+ *
+ * After the installation is completed, the device will be running in the new system on next the
+ * reboot. Then, when the user reboots the device again, it will leave {@code DynamicSystem} and go
+ * back to the original system. While running in {@code DynamicSystem}, persitent storage for
+ * factory reset protection (FRP) remains unchanged. Since the user is running the new system with
+ * a temporarily created data partition, their original user data are kept unchanged.</p>
  *
  * <p>With {@link #setOnStatusChangedListener}, API users can register an
- * {@link #OnStatusChangedListener} and get status updates and cause when the installation is
+ * {@link #OnStatusChangedListener} to get status updates and their causes when the installation is
  * started, stopped, or cancelled. It also sends progress updates during the installation. With
- * {@link #start}, API users can start an installation with the {@link Uri} to a gzipped system
- * image. The {@link Uri} can be a web URL or a content Uri to a local path.</p>
+ * {@link #start}, API users can start an installation with the {@link Uri} to a unsparsed and
+ * gzipped system image. The {@link Uri} can be a web URL or a content Uri to a local path.</p>
  *
  * @hide
  */