From 212d6930cc8f2a64d37d68141b7c78ee39a053a3 Mon Sep 17 00:00:00 2001 From: Remi NGUYEN VAN Date: Thu, 8 Apr 2021 15:32:08 +0900 Subject: [PATCH] Add documentation on EthernetNetworkSpecifier API Add javadoc on the constructor and getInterfaceName method. Fixes: 182979732 Test: m Change-Id: Iced805149a8344b953331501b48184661be0053a --- core/java/android/net/EthernetNetworkSpecifier.java | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/core/java/android/net/EthernetNetworkSpecifier.java b/core/java/android/net/EthernetNetworkSpecifier.java index e1685887e8..62c5761442 100644 --- a/core/java/android/net/EthernetNetworkSpecifier.java +++ b/core/java/android/net/EthernetNetworkSpecifier.java @@ -42,15 +42,22 @@ public final class EthernetNetworkSpecifier extends NetworkSpecifier implements @NonNull private final String mInterfaceName; + /** + * Create a new EthernetNetworkSpecifier. + * @param interfaceName Name of the ethernet interface the specifier refers to. + */ public EthernetNetworkSpecifier(@NonNull String interfaceName) { Preconditions.checkStringNotEmpty(interfaceName); mInterfaceName = interfaceName; } - // This may be null in the future to support specifiers based on data other than the interface - // name. + /** + * Get the name of the ethernet interface the specifier refers to. + */ @Nullable public String getInterfaceName() { + // This may be null in the future to support specifiers based on data other than the + // interface name. return mInterfaceName; }