diff options
| author | 2021-02-10 10:32:37 -0800 | |
|---|---|---|
| committer | 2021-02-11 14:33:14 -0800 | |
| commit | 1d75e795090a07e0e4407ae17436de8b5b87b4ac (patch) | |
| tree | afab134008155af47d35c10db5b02f03633cb0ff | |
| parent | 331f3be480e9b21a02d4d5462549e4a5b0bb2a50 (diff) | |
Replace @code with @link for setSchema.
Now that the visibility APIs are exposed, we can properly @link to the
methods in the documentation.
Bug: 169883602
Test: presubmit
Change-Id: Ic5e9cb5f4279077cae72a566a631163ca7dd7264
| -rw-r--r-- | apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java | 12 | ||||
| -rw-r--r-- | apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java | 12 |
2 files changed, 10 insertions, 14 deletions
diff --git a/apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java b/apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java index 8723515e1fdb..8fcd2f9bffb2 100644 --- a/apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java +++ b/apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java @@ -146,19 +146,17 @@ public final class AppSearchSession implements Closeable { * <p>It is a no-op to set the same schema as has been previously set; this is handled * efficiently. * - * <p>By default, documents are visible on platform surfaces. To opt out, call {@code - * SetSchemaRequest.Builder#setPlatformSurfaceable} with {@code surfaceable} as false. Any - * visibility settings apply only to the schemas that are included in the {@code request}. - * Visibility settings for a schema type do not apply or persist across - * {@link SetSchemaRequest}s. + * <p>By default, documents are visible on platform surfaces. To opt out, call + * {@link SetSchemaRequest.Builder#setSchemaTypeVisibilityForSystemUi} with {@code visible} as + * false. Any visibility settings apply only to the schemas that are included in the + * {@code request}. Visibility settings for a schema type do not persist across + * {@link #setSchema} calls. * * @param request The schema update request. * @param executor Executor on which to invoke the callback. * @param callback Callback to receive errors resulting from setting the schema. If the * operation succeeds, the callback will be invoked with {@code null}. */ - // TODO(b/169883602): Change @code references to @link when setPlatformSurfaceable APIs are - // exposed. public void setSchema( @NonNull SetSchemaRequest request, @NonNull @CallbackExecutor Executor executor, diff --git a/apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java b/apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java index 8e62c0e57f7d..b2ffd5b4b60c 100644 --- a/apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java +++ b/apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java @@ -86,11 +86,11 @@ public interface AppSearchSessionShim extends Closeable { * <p>It is a no-op to set the same schema as has been previously set; this is handled * efficiently. * - * <p>By default, documents are visible on platform surfaces. To opt out, call {@code - * SetSchemaRequest.Builder#setPlatformSurfaceable} with {@code surfaceable} as false. Any - * visibility settings apply only to the schemas that are included in the {@code request}. - * Visibility settings for a schema type do not apply or persist across {@link - * SetSchemaRequest}s. + * <p>By default, documents are visible on platform surfaces. To opt out, call + * {@link SetSchemaRequest.Builder#setSchemaTypeVisibilityForSystemUi} with {@code visible} as + * false. Any visibility settings apply only to the schemas that are included in the + * {@code request}. Visibility settings for a schema type do not persist across + * {@link #setSchema} calls. * * <p>Migration: make non-backwards-compatible changes will delete all stored documents in old * schema. You can save your documents by setting {@link @@ -116,8 +116,6 @@ public interface AppSearchSessionShim extends Closeable { * @see android.app.appsearch.AppSearchSchema.Migrator * @see android.app.appsearch.AppSearchMigrationHelper.Transformer */ - // TODO(b/169883602): Change @code references to @link when setPlatformSurfaceable APIs are - // exposed. @NonNull ListenableFuture<SetSchemaResponse> setSchema(@NonNull SetSchemaRequest request); |