From 24aa7bc5cb9eabd1f954a910da7a2239a63b68e3 Mon Sep 17 00:00:00 2001 From: Cody Kesting Date: Wed, 31 Mar 2021 10:43:23 -0700 Subject: [PATCH] Clarify docs for status codes in VcnStatusCallback. This CL clarifies the documentation for status codes used in VcnStatusCallback #onStatusChanged() and #onGatewayConnectionError, per API Council feedback. Bug: 182345902 Test: atest FrameworksVcnTests CtsVcnTestCases Change-Id: I86770a19f3d9f9a42aa3713489943fbe78561773 --- core/java/android/net/vcn/VcnManager.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/core/java/android/net/vcn/VcnManager.java b/core/java/android/net/vcn/VcnManager.java index d09094cee1bf3..344b20c036a0c 100644 --- a/core/java/android/net/vcn/VcnManager.java +++ b/core/java/android/net/vcn/VcnManager.java @@ -437,7 +437,7 @@ public class VcnManager { * Invoked when status of the VCN for this callback's subscription group changes. * * @param statusCode the code for the status change encountered by this {@link - * VcnStatusCallback}'s subscription group. + * VcnStatusCallback}'s subscription group. This value will be one of VCN_STATUS_CODE_*. */ public abstract void onStatusChanged(@VcnStatusCode int statusCode); @@ -449,7 +449,8 @@ public class VcnManager { * encountering an error. This will match the name for exactly one {@link * VcnGatewayConnectionConfig} for the {@link VcnConfig} configured for this callback's * subscription group - * @param errorCode the code to indicate the error that occurred + * @param errorCode the code to indicate the error that occurred. This value will be one of + * VCN_ERROR_CODE_*. * @param detail Throwable to provide additional information about the error, or {@code * null} if none */