Fix documentation for NetworkStatsManager methods.

Test: N/A
Change-Id: I054ce104e561ece8e414c7ddad718665e51a692e
This commit is contained in:
Stephen Chen
2016-11-07 11:31:24 -08:00
parent 357f8fabc8
commit 4f1700dd16

View File

@@ -182,10 +182,10 @@ public class NetworkStatsManager {
/** /**
* Query network usage statistics summaries. Result filtered to include only uids belonging to * Query network usage statistics summaries. Result filtered to include only uids belonging to
* calling user. Result is aggregated over time, hence all buckets will have the same start and * calling user. Result is aggregated over time, hence all buckets will have the same start and
* end timestamps. State is going to be {@link NetworkStats.Bucket#STATE_ALL}, * end timestamps. Not aggregated over state, uid, metered, or roaming. This means buckets'
* uid {@link NetworkStats.Bucket#UID_ALL}, tag {@link NetworkStats.Bucket#TAG_NONE}, * start and end timestamps are going to be the same as the 'startTime' and 'endTime'
* metered {@link NetworkStats.Bucket#METERED_ALL}, and roaming * parameters. State, uid, metered, and roaming are going to vary, and tag is going to be the
* {@link NetworkStats.Bucket#ROAMING_ALL}. * same.
* *
* @param networkType As defined in {@link ConnectivityManager}, e.g. * @param networkType As defined in {@link ConnectivityManager}, e.g.
* {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI} * {@link ConnectivityManager#TYPE_MOBILE}, {@link ConnectivityManager#TYPE_WIFI}
@@ -231,7 +231,9 @@ public class NetworkStatsManager {
* belonging to calling user. Result is aggregated over state but not aggregated over time. * belonging to calling user. Result is aggregated over state but not aggregated over time.
* This means buckets' start and end timestamps are going to be between 'startTime' and * This means buckets' start and end timestamps are going to be between 'startTime' and
* 'endTime' parameters. State is going to be {@link NetworkStats.Bucket#STATE_ALL}, uid the * 'endTime' parameters. State is going to be {@link NetworkStats.Bucket#STATE_ALL}, uid the
* same as the 'uid' parameter and tag the same as 'tag' parameter. * same as the 'uid' parameter and tag the same as 'tag' parameter. metered is going to be
* {@link NetworkStats.Bucket#METERED_ALL}, and roaming is going to be
* {@link NetworkStats.Bucket#ROAMING_ALL}.
* <p>Only includes buckets that atomically occur in the inclusive time range. Doesn't * <p>Only includes buckets that atomically occur in the inclusive time range. Doesn't
* interpolate across partial buckets. Since bucket length is in the order of hours, this * interpolate across partial buckets. Since bucket length is in the order of hours, this
* method cannot be used to measure data usage on a fine grained time scale. * method cannot be used to measure data usage on a fine grained time scale.