Address EthernetManager javadoc review comments

Test: TH
Change-Id: Iafa8979d8e96ea4d078b017e56ee61334d33b5f5
This commit is contained in:
Patrick Rohr
2022-03-28 13:03:08 +02:00
parent 0f2cbe92f1
commit 50c470e308

View File

@@ -541,8 +541,7 @@ public class EthernetManager {
* Similarly, use {@link NetworkCapabilities.Builder} to build a {@code NetworkCapabilities}
* object for this network to put inside the {@code request}.
*
* This function accepts an {@link OutcomeReceiver} that is called once the operation has
* finished execution.
* The provided {@link OutcomeReceiver} is called once the operation has finished execution.
*
* @param iface the name of the interface to act upon.
* @param request the {@link EthernetNetworkUpdateRequest} used to set an ethernet network's
@@ -583,9 +582,9 @@ public class EthernetManager {
/**
* Enable a network interface.
*
* Enables a previously disabled network interface.
* This function accepts an {@link OutcomeReceiver} that is called once the operation has
* finished execution.
* Enables a previously disabled network interface. An attempt to enable an already-enabled
* interface is ignored.
* The provided {@link OutcomeReceiver} is called once the operation has finished execution.
*
* @param iface the name of the interface to enable.
* @param executor an {@link Executor} to execute the callback on. Optional if callback is null.
@@ -620,10 +619,9 @@ public class EthernetManager {
/**
* Disable a network interface.
*
* Disables the use of a network interface to fulfill network requests. If the interface
* currently serves a request, the network will be torn down.
* This function accepts an {@link OutcomeReceiver} that is called once the operation has
* finished execution.
* Disables the specified interface. If this interface is in use in a connected
* {@link android.net.Network}, then that {@code Network} will be torn down.
* The provided {@link OutcomeReceiver} is called once the operation has finished execution.
*
* @param iface the name of the interface to disable.
* @param executor an {@link Executor} to execute the callback on. Optional if callback is null.