drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix typos in ConnectivityManager documentation.

Browse Source 
Spun off from
https://partner-android-review.googlesource.com/#/c/205463/ for
ease of review.

Bug: 19416463
Change-Id: I2f88ac415177ecd96c9191df5e390830869f52e1
This commit is contained in:
Paul Jensen
2015-02-13 14:18:39 -05:00
committed by Lorenzo Colitti
parent b4d90fca0e
commit 0d719cab11
1 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
core/java/android/net/ConnectivityManager.java
View File

@ -588,9 +588,9 @@ public class ConnectivityManager {
* network. * network.
* *
* @return a {@link NetworkInfo} object for the current default network * @return a {@link NetworkInfo} object for the current default network
* or {@code null} if no network default network is currently active * or {@code null} if no default network is currently active
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
*/ */
public NetworkInfo getActiveNetworkInfo() { public NetworkInfo getActiveNetworkInfo() {
@ -737,9 +737,9 @@ public class ConnectivityManager {
* network. * network.
* *
* @return a {@link NetworkInfo} object for the current default network * @return a {@link NetworkInfo} object for the current default network
* or {@code null} if no network default network is currently active * or {@code null} if no default network is currently active
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* *
* {@hide} * {@hide}
@ -759,7 +759,7 @@ public class ConnectivityManager {
* for the current default network, or {@code null} if there * for the current default network, or {@code null} if there
* is no current default network. * is no current default network.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -779,7 +779,7 @@ public class ConnectivityManager {
* for the given networkType, or {@code null} if there is * for the given networkType, or {@code null} if there is
* no current default network. * no current default network.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -829,7 +829,7 @@ public class ConnectivityManager {
* @return a boolean, {@code true} indicating success. All network types * @return a boolean, {@code true} indicating success. All network types
* will be tried, even if some fail. * will be tried, even if some fail.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE}. * {@link android.Manifest.permission#CHANGE_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -850,7 +850,7 @@ public class ConnectivityManager {
* {@code} false to turn it off. * {@code} false to turn it off.
* @return a boolean, {@code true} indicating success. * @return a boolean, {@code true} indicating success.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE}. * {@link android.Manifest.permission#CHANGE_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1272,7 +1272,7 @@ public class ConnectivityManager {
* network is active. Quota status can change rapidly, so these values * network is active. Quota status can change rapidly, so these values
* shouldn't be cached. * shouldn't be cached.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* *
* @hide * @hide
@ -1451,7 +1451,7 @@ public class ConnectivityManager {
* *
* @return an array of 0 or more Strings of tetherable interface names. * @return an array of 0 or more Strings of tetherable interface names.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1468,7 +1468,7 @@ public class ConnectivityManager {
* *
* @return an array of 0 or more String of currently tethered interface names. * @return an array of 0 or more String of currently tethered interface names.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1491,7 +1491,7 @@ public class ConnectivityManager {
* @return an array of 0 or more String indicating the interface names * @return an array of 0 or more String indicating the interface names
* which failed to tether. * which failed to tether.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1529,7 +1529,7 @@ public class ConnectivityManager {
* @param iface the interface name to tether. * @param iface the interface name to tether.
* @return error a {@code TETHER_ERROR} value indicating success or failure type * @return error a {@code TETHER_ERROR} value indicating success or failure type
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE}. * {@link android.Manifest.permission#CHANGE_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1547,7 +1547,7 @@ public class ConnectivityManager {
* @param iface the interface name to untether. * @param iface the interface name to untether.
* @return error a {@code TETHER_ERROR} value indicating success or failure type * @return error a {@code TETHER_ERROR} value indicating success or failure type
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE}. * {@link android.Manifest.permission#CHANGE_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1566,7 +1566,7 @@ public class ConnectivityManager {
* *
* @return a boolean - {@code true} indicating Tethering is supported. * @return a boolean - {@code true} indicating Tethering is supported.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1586,7 +1586,7 @@ public class ConnectivityManager {
* @return an array of 0 or more regular expression Strings defining * @return an array of 0 or more regular expression Strings defining
* what interfaces are considered tetherable usb interfaces. * what interfaces are considered tetherable usb interfaces.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1606,7 +1606,7 @@ public class ConnectivityManager {
* @return an array of 0 or more regular expression Strings defining * @return an array of 0 or more regular expression Strings defining
* what interfaces are considered tetherable wifi interfaces. * what interfaces are considered tetherable wifi interfaces.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1626,7 +1626,7 @@ public class ConnectivityManager {
* @return an array of 0 or more regular expression Strings defining * @return an array of 0 or more regular expression Strings defining
* what interfaces are considered tetherable bluetooth interfaces. * what interfaces are considered tetherable bluetooth interfaces.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1648,7 +1648,7 @@ public class ConnectivityManager {
* @param enable a boolean - {@code true} to enable tethering * @param enable a boolean - {@code true} to enable tethering
* @return error a {@code TETHER_ERROR} value indicating success or failure type * @return error a {@code TETHER_ERROR} value indicating success or failure type
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE}. * {@link android.Manifest.permission#CHANGE_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1691,7 +1691,7 @@ public class ConnectivityManager {
* @return error The error code of the last error tethering or untethering the named * @return error The error code of the last error tethering or untethering the named
* interface * interface
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* {@hide} * {@hide}
*/ */
@ -1710,7 +1710,7 @@ public class ConnectivityManager {
* @param networkType The type of network you want to report on * @param networkType The type of network you want to report on
* @param percentage The quality of the connection 0 is bad, 100 is good * @param percentage The quality of the connection 0 is bad, 100 is good
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#STATUS_BAR}. * {@link android.Manifest.permission#STATUS_BAR}.
* {@hide} * {@hide}
*/ */
@ -1746,7 +1746,7 @@ public class ConnectivityManager {
* @param p The a {@link ProxyInfo} object defining the new global * @param p The a {@link ProxyInfo} object defining the new global
* HTTP proxy. A {@code null} value will clear the global HTTP proxy. * HTTP proxy. A {@code null} value will clear the global HTTP proxy.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* android.Manifest.permission#CONNECTIVITY_INTERNAL. * android.Manifest.permission#CONNECTIVITY_INTERNAL.
* @hide * @hide
*/ */
@ -1763,7 +1763,7 @@ public class ConnectivityManager {
* @return {@link ProxyInfo} for the current global HTTP proxy or {@code null} * @return {@link ProxyInfo} for the current global HTTP proxy or {@code null}
* if no global HTTP proxy is set. * if no global HTTP proxy is set.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* @hide * @hide
*/ */
@ -1811,7 +1811,7 @@ public class ConnectivityManager {
* @param networkType The network type we'd like to check * @param networkType The network type we'd like to check
* @return {@code true} if supported, else {@code false} * @return {@code true} if supported, else {@code false}
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* @hide * @hide
*/ */
@ -1833,7 +1833,7 @@ public class ConnectivityManager {
* @return {@code true} if large transfers should be avoided, otherwise * @return {@code true} if large transfers should be avoided, otherwise
* {@code false}. * {@code false}.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
*/ */
public boolean isActiveNetworkMetered() { public boolean isActiveNetworkMetered() {
@ -1869,7 +1869,7 @@ public class ConnectivityManager {
* in question. * in question.
* @param isCaptivePortal true/false. * @param isCaptivePortal true/false.
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CONNECTIVITY_INTERNAL}. * {@link android.Manifest.permission#CONNECTIVITY_INTERNAL}.
* {@hide} * {@hide}
*/ */
@ -1944,7 +1944,7 @@ public class ConnectivityManager {
* *
* @param enable whether to enable airplane mode or not * @param enable whether to enable airplane mode or not
* *
* <p>This method requires the call to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#CONNECTIVITY_INTERNAL}. * {@link android.Manifest.permission#CONNECTIVITY_INTERNAL}.
* @hide * @hide
*/ */