Merge "Correct javadoc usage"

This commit is contained in:
Chiachang Wang
2022-07-15 07:41:33 +00:00
committed by Gerrit Code Review
13 changed files with 33 additions and 33 deletions

View File

@@ -296,7 +296,7 @@ public class EntitlementManager {
* 4th priority : Checks whether provisioning is required from RRO configuration. * 4th priority : Checks whether provisioning is required from RRO configuration.
* *
* @param config * @param config
* @return integer {@see #TETHERING_PROVISIONING_NOT_REQUIRED, * @return integer See {@link #TETHERING_PROVISIONING_NOT_REQUIRED,
* #TETHERING_PROVISIONING_REQUIRED, * #TETHERING_PROVISIONING_REQUIRED,
* #TETHERING_PROVISIONING_CARRIER_UNSUPPORT} * #TETHERING_PROVISIONING_CARRIER_UNSUPPORT}
*/ */

View File

@@ -118,7 +118,7 @@ public abstract class NetworkStatsProvider {
* *
* @param token the token under which these stats were gathered. Providers can call this method * @param token the token under which these stats were gathered. Providers can call this method
* with the current token as often as they want, until the token changes. * with the current token as often as they want, until the token changes.
* {@see NetworkStatsProvider#onRequestStatsUpdate()} * See {@link NetworkStatsProvider#onRequestStatsUpdate(int)}
* @param ifaceStats the {@link NetworkStats} per interface to be reported. * @param ifaceStats the {@link NetworkStats} per interface to be reported.
* The provider should not include any traffic that is already counted by * The provider should not include any traffic that is already counted by
* kernel interface counters. * kernel interface counters.

View File

@@ -126,7 +126,7 @@ import java.util.concurrent.Executor;
* http://www.iana.org/form/ports-service. Existing services can be found at * http://www.iana.org/form/ports-service. Existing services can be found at
* http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml * http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml
* *
* {@see NsdServiceInfo} * @see NsdServiceInfo
*/ */
@SystemService(Context.NSD_SERVICE) @SystemService(Context.NSD_SERVICE)
public final class NsdManager { public final class NsdManager {

View File

@@ -34,7 +34,7 @@ import java.util.Map;
/** /**
* A class representing service information for network service discovery * A class representing service information for network service discovery
* {@see NsdManager} * @see NsdManager
*/ */
public final class NsdServiceInfo implements Parcelable { public final class NsdServiceInfo implements Parcelable {

View File

@@ -556,7 +556,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_MOBILE = 0; public static final int TYPE_MOBILE = 0;
@@ -566,7 +566,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_WIFI = 1; public static final int TYPE_WIFI = 1;
@@ -617,7 +617,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_MOBILE_HIPRI = 5; public static final int TYPE_MOBILE_HIPRI = 5;
@@ -627,7 +627,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_WIMAX = 6; public static final int TYPE_WIMAX = 6;
@@ -637,7 +637,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_BLUETOOTH = 7; public static final int TYPE_BLUETOOTH = 7;
@@ -654,7 +654,7 @@ public class ConnectivityManager {
* *
* @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or * @deprecated Applications should instead use {@link NetworkCapabilities#hasTransport} or
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an * {@link #requestNetwork(NetworkRequest, NetworkCallback)} to request an
* appropriate network. {@see NetworkCapabilities} for supported transports. * appropriate network. See {@link NetworkCapabilities} for supported transports.
*/ */
@Deprecated @Deprecated
public static final int TYPE_ETHERNET = 9; public static final int TYPE_ETHERNET = 9;
@@ -1204,7 +1204,7 @@ public class ConnectivityManager {
/** /**
* Preference for {@link ProfileNetworkPreference#setPreference(int)}. * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
* {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
* Specify that the traffic for this user should by follow the default rules. * Specify that the traffic for this user should by follow the default rules.
* @hide * @hide
*/ */
@@ -1213,7 +1213,7 @@ public class ConnectivityManager {
/** /**
* Preference for {@link ProfileNetworkPreference#setPreference(int)}. * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
* {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
* Specify that the traffic for this user should by default go on a network with * Specify that the traffic for this user should by default go on a network with
* {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE}, and on the system default network
* if no such network is available. * if no such network is available.
@@ -1224,7 +1224,7 @@ public class ConnectivityManager {
/** /**
* Preference for {@link ProfileNetworkPreference#setPreference(int)}. * Preference for {@link ProfileNetworkPreference#setPreference(int)}.
* {@see #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)} * See {@link #setProfileNetworkPreferences(UserHandle, List, Executor, Runnable)}
* Specify that the traffic for this user should by default go on a network with * Specify that the traffic for this user should by default go on a network with
* {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available * {@link NetworkCapabilities#NET_CAPABILITY_ENTERPRISE} and if no such network is available
* should not go on the system default network * should not go on the system default network
@@ -3383,8 +3383,8 @@ public class ConnectivityManager {
* proxy is likely to break networking on multiple networks. This method is only meant * proxy is likely to break networking on multiple networks. This method is only meant
* for device policy clients looking to do general internal filtering or similar use cases. * for device policy clients looking to do general internal filtering or similar use cases.
* *
* {@see #getGlobalProxy} * @see #getGlobalProxy
* {@see LinkProperties#getHttpProxy} * @see LinkProperties#getHttpProxy
* *
* @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this * @param p A {@link ProxyInfo} object defining the new global HTTP proxy. Calling this
* method with a {@code null} value will clear the global HTTP proxy. * method with a {@code null} value will clear the global HTTP proxy.
@@ -4277,7 +4277,7 @@ public class ConnectivityManager {
* network, unless it becomes the best again at some later time. All callbacks are invoked * network, unless it becomes the best again at some later time. All callbacks are invoked
* in order on the same thread, which by default is a thread created by the framework running * in order on the same thread, which by default is a thread created by the framework running
* in the app. * in the app.
* {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the * See {@link #requestNetwork(NetworkRequest, NetworkCallback, Handler)} to change where the
* callbacks are invoked. * callbacks are invoked.
* *
* <p>This{@link NetworkRequest} will live until released via * <p>This{@link NetworkRequest} will live until released via

View File

@@ -137,7 +137,7 @@ public final class DnsResolver {
* @param answer <T> answer to the query. * @param answer <T> answer to the query.
* @param rcode The response code in the DNS response. * @param rcode The response code in the DNS response.
* *
* {@see android.net.DnsResolver#query query()} * @see android.net.DnsResolver#query query()
*/ */
void onAnswer(@NonNull T answer, int rcode); void onAnswer(@NonNull T answer, int rcode);
/** /**

View File

@@ -84,7 +84,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
* the correct packets. Devices typically have a small number of slots * the correct packets. Devices typically have a small number of slots
* per radio technology, and the specific number of slots for each * per radio technology, and the specific number of slots for each
* technology is specified in configuration files. * technology is specified in configuration files.
* {@see SocketKeepalive} for details. * See {@link SocketKeepalive} for details.
* *
* @hide * @hide
*/ */

View File

@@ -252,7 +252,7 @@ public final class NetworkAgentConfig implements Parcelable {
/** /**
* Whether network validation should be performed for this VPN network. * Whether network validation should be performed for this VPN network.
* {@see #isVpnValidationRequired} * @see #isVpnValidationRequired
* @hide * @hide
*/ */
private boolean mVpnRequiresValidation = false; private boolean mVpnRequiresValidation = false;

View File

@@ -192,7 +192,7 @@ public final class NetworkCapabilities implements Parcelable {
/** /**
* Bitfield representing the network's enterprise capability identifier. If any are specified * Bitfield representing the network's enterprise capability identifier. If any are specified
* they will be satisfied by any Network that matches all of them. * they will be satisfied by any Network that matches all of them.
* {@see addEnterpriseId} for details on how masks are added * See {@link #addEnterpriseId(int)} for details on how masks are added
*/ */
private int mEnterpriseId; private int mEnterpriseId;
@@ -1460,7 +1460,7 @@ public final class NetworkCapabilities implements Parcelable {
* Sets the upstream bandwidth for this network in Kbps. This always only refers to * Sets the upstream bandwidth for this network in Kbps. This always only refers to
* the estimated first hop transport bandwidth. * the estimated first hop transport bandwidth.
* <p> * <p>
* {@see Builder#setLinkUpstreamBandwidthKbps} * @see Builder#setLinkUpstreamBandwidthKbps
* *
* @param upKbps the estimated first hop upstream (device to network) bandwidth. * @param upKbps the estimated first hop upstream (device to network) bandwidth.
* @hide * @hide
@@ -1484,7 +1484,7 @@ public final class NetworkCapabilities implements Parcelable {
* Sets the downstream bandwidth for this network in Kbps. This always only refers to * Sets the downstream bandwidth for this network in Kbps. This always only refers to
* the estimated first hop transport bandwidth. * the estimated first hop transport bandwidth.
* <p> * <p>
* {@see Builder#setLinkUpstreamBandwidthKbps} * @see Builder#setLinkUpstreamBandwidthKbps
* *
* @param downKbps the estimated first hop downstream (network to device) bandwidth. * @param downKbps the estimated first hop downstream (network to device) bandwidth.
* @hide * @hide
@@ -2534,7 +2534,7 @@ public final class NetworkCapabilities implements Parcelable {
/** /**
* Set the uid and package name of the app causing this network to exist. * Set the uid and package name of the app causing this network to exist.
* *
* {@see #setRequestorUid} and {@link #setRequestorPackageName} * See {@link #setRequestorUid} and {@link #setRequestorPackageName}
* *
* @param uid UID of the app. * @param uid UID of the app.
* @param packageName package name of the app. * @param packageName package name of the app.
@@ -2719,7 +2719,7 @@ public final class NetworkCapabilities implements Parcelable {
/** /**
* Removes the given transport type. * Removes the given transport type.
* *
* {@see #addTransportType}. * @see #addTransportType
* *
* @param transportType the transport type to be added or removed. * @param transportType the transport type to be added or removed.
* @return this builder * @return this builder

View File

@@ -79,7 +79,7 @@ public final class ProfileNetworkPreference implements Parcelable {
* if included is not empty, then only included UIDs are applied. * if included is not empty, then only included UIDs are applied.
* if excluded is not empty, then it is all uids in the user profile except these UIDs. * if excluded is not empty, then it is all uids in the user profile except these UIDs.
* @return Array of uids included for the profile preference. * @return Array of uids included for the profile preference.
* {@see #getExcludedUids()} * @see #getExcludedUids()
*/ */
public @NonNull int[] getIncludedUids() { public @NonNull int[] getIncludedUids() {
return mIncludedUids.clone(); return mIncludedUids.clone();
@@ -93,7 +93,7 @@ public final class ProfileNetworkPreference implements Parcelable {
* <ul>If included is not empty, then only included UIDs are applied.</ul> * <ul>If included is not empty, then only included UIDs are applied.</ul>
* <ul>If excluded is not empty, then it is all uids in the user profile except these UIDs.</ul> * <ul>If excluded is not empty, then it is all uids in the user profile except these UIDs.</ul>
* @return Array of uids not included for the profile preference. * @return Array of uids not included for the profile preference.
* {@see #getIncludedUids()} * @see #getIncludedUids()
*/ */
public @NonNull int[] getExcludedUids() { public @NonNull int[] getExcludedUids() {
return mExcludedUids.clone(); return mExcludedUids.clone();
@@ -177,7 +177,7 @@ public final class ProfileNetworkPreference implements Parcelable {
/** /**
* This is a array of uids for which profile perefence is set. * This is a array of uids for which profile perefence is set.
* Empty would mean that this preference applies to all uids in the profile. * Empty would mean that this preference applies to all uids in the profile.
* {@see #setExcludedUids(int[])} * @see #setExcludedUids(int[])
* Included UIDs and Excluded UIDs can't both be non-empty. * Included UIDs and Excluded UIDs can't both be non-empty.
* if both are empty, it means this request applies to all uids in the user profile. * if both are empty, it means this request applies to all uids in the user profile.
* if included is not empty, then only included UIDs are applied. * if included is not empty, then only included UIDs are applied.
@@ -195,7 +195,7 @@ public final class ProfileNetworkPreference implements Parcelable {
/** /**
* This is a array of uids that are excluded for the profile perefence. * This is a array of uids that are excluded for the profile perefence.
* {@see #setIncludedUids(int[])} * @see #setIncludedUids(int[])
* Included UIDs and Excluded UIDs can't both be non-empty. * Included UIDs and Excluded UIDs can't both be non-empty.
* if both are empty, it means this request applies to all uids in the user profile. * if both are empty, it means this request applies to all uids in the user profile.
* if included is not empty, then only included UIDs are applied. * if included is not empty, then only included UIDs are applied.

View File

@@ -303,7 +303,7 @@ public class NetworkStatsService extends INetworkStatsService.Stub {
/** /**
* When enabled, all mobile data is reported under {@link NetworkTemplate#NETWORK_TYPE_ALL}. * When enabled, all mobile data is reported under {@link NetworkTemplate#NETWORK_TYPE_ALL}.
* When disabled, mobile data is broken down by a granular ratType representative of the * When disabled, mobile data is broken down by a granular ratType representative of the
* actual ratType. {@see android.app.usage.NetworkStatsManager#getCollapsedRatType}. * actual ratType. See {@link android.app.usage.NetworkStatsManager#getCollapsedRatType}.
* Enabling this decreases the level of detail but saves performance, disk space and * Enabling this decreases the level of detail but saves performance, disk space and
* amount of data logged. * amount of data logged.
*/ */

View File

@@ -453,7 +453,7 @@ public class ConnectivityService extends IConnectivityManager.Stub
* direct device-originated data traffic of the specific UIDs to the correct * direct device-originated data traffic of the specific UIDs to the correct
* default network for each app. * default network for each app.
* Order ints passed to netd must be in the 0~999 range. Larger values code for * Order ints passed to netd must be in the 0~999 range. Larger values code for
* a lower priority, {@see NativeUidRangeConfig} * a lower priority, see {@link NativeUidRangeConfig}.
* *
* Requests that don't code for a per-app preference use PREFERENCE_ORDER_INVALID. * Requests that don't code for a per-app preference use PREFERENCE_ORDER_INVALID.
* The default request uses PREFERENCE_ORDER_DEFAULT. * The default request uses PREFERENCE_ORDER_DEFAULT.

View File

@@ -76,16 +76,16 @@ public class FullScore {
public static final int POLICY_IS_VPN = 62; public static final int POLICY_IS_VPN = 62;
// This network has been selected by the user manually from settings or a 3rd party app // This network has been selected by the user manually from settings or a 3rd party app
// at least once. {@see NetworkAgentConfig#explicitlySelected}. // at least once. @see NetworkAgentConfig#explicitlySelected.
/** @hide */ /** @hide */
public static final int POLICY_EVER_USER_SELECTED = 61; public static final int POLICY_EVER_USER_SELECTED = 61;
// The user has indicated in UI that this network should be used even if it doesn't // The user has indicated in UI that this network should be used even if it doesn't
// validate. {@see NetworkAgentConfig#acceptUnvalidated}. // validate. @see NetworkAgentConfig#acceptUnvalidated.
/** @hide */ /** @hide */
public static final int POLICY_ACCEPT_UNVALIDATED = 60; public static final int POLICY_ACCEPT_UNVALIDATED = 60;
// This network is unmetered. {@see NetworkCapabilities.NET_CAPABILITY_NOT_METERED}. // This network is unmetered. @see NetworkCapabilities.NET_CAPABILITY_NOT_METERED.
/** @hide */ /** @hide */
public static final int POLICY_IS_UNMETERED = 59; public static final int POLICY_IS_UNMETERED = 59;