Fix the javadoc for LocationManager.requestSingleUpdate() (e23fc8ee) · Commits · e / os / android_frameworks_base

location/java/android/location/LocationManager.java

+26 −22

Original line number	Original line	Diff line number	Diff line
	@@ -715,15 +715,13 @@ public class LocationManager {
	}		}

	/**		/**
	* Registers the current activity to be notified periodically by		* Requests a single location update from the named provider.
	* the named provider. Periodically, the supplied LocationListener will
	* be called with the current Location or with status updates.
	*		*
	* <p> It may take a while to receive the most recent location. If		* <p> It may take a while to receive the most recent location. If
	* an immediate location is required, applications may use the		* an immediate location is required, applications may use the
	* {@link #getLastKnownLocation(String)} method.		* {@link #getLastKnownLocation(String)} method.
	*		*
	* <p> In case the provider is disabled by the user, updates will stop,		* <p> In case the provider is disabled by the user, the update will not be received,
	* and the {@link LocationListener#onProviderDisabled(String)}		* and the {@link LocationListener#onProviderDisabled(String)}
	* method will be called. As soon as the provider is enabled again,		* method will be called. As soon as the provider is enabled again,
	* the {@link LocationListener#onProviderEnabled(String)} method will		* the {@link LocationListener#onProviderEnabled(String)} method will
	@@ -733,8 +731,8 @@ public class LocationManager {
	*		*
	* @param provider the name of the provider with which to register		* @param provider the name of the provider with which to register
	* @param listener a {#link LocationListener} whose		* @param listener a {#link LocationListener} whose
	* {@link LocationListener#onLocationChanged} method will be called for		* {@link LocationListener#onLocationChanged} method will be called when
	* each location update		* the location update is available
	* @param looper a Looper object whose message queue will be used to		* @param looper a Looper object whose message queue will be used to
	* implement the callback mechanism.		* implement the callback mechanism.
	* If looper is null then the callbacks will be called on the main thread.		* If looper is null then the callbacks will be called on the main thread.
	@@ -754,15 +752,13 @@ public class LocationManager {
	}		}

	/**		/**
	* Registers the current activity to be notified periodically based on		* Requests a single location update based on the specified criteria.
	* the specified criteria. Periodically, the supplied LocationListener will
	* be called with the current Location or with status updates.
	*		*
	* <p> It may take a while to receive the most recent location. If		* <p> It may take a while to receive the most recent location. If
	* an immediate location is required, applications may use the		* an immediate location is required, applications may use the
	* {@link #getLastKnownLocation(String)} method.		* {@link #getLastKnownLocation(String)} method.
	*		*
	* <p> In case the provider is disabled by the user, updates will stop,		* <p> In case the provider is disabled by the user, the update will not be received,
	* and the {@link LocationListener#onProviderDisabled(String)}		* and the {@link LocationListener#onProviderDisabled(String)}
	* method will be called. As soon as the provider is enabled again,		* method will be called. As soon as the provider is enabled again,
	* the {@link LocationListener#onProviderEnabled(String)} method will		* the {@link LocationListener#onProviderEnabled(String)} method will
	@@ -773,8 +769,8 @@ public class LocationManager {
	* @param criteria contains parameters for the location manager to choose the		* @param criteria contains parameters for the location manager to choose the
	* appropriate provider and parameters to compute the location		* appropriate provider and parameters to compute the location
	* @param listener a {#link LocationListener} whose		* @param listener a {#link LocationListener} whose
	* {@link LocationListener#onLocationChanged} method will be called for		* {@link LocationListener#onLocationChanged} method will be called when
	* each location update		* the location update is available
	* @param looper a Looper object whose message queue will be used to		* @param looper a Looper object whose message queue will be used to
	* implement the callback mechanism.		* implement the callback mechanism.
	* If looper is null then the callbacks will be called on the current thread.		* If looper is null then the callbacks will be called on the current thread.
	@@ -795,16 +791,20 @@ public class LocationManager {
	}		}

	/**		/**
	* Registers the current activity to be notified periodically by		* Requests a single location update from the named provider.
	* the named provider. Periodically, the supplied PendingIntent will
	* be broadcast with the current Location or with status updates.
	*
	* <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
	*		*
	* <p> It may take a while to receive the most recent location. If		* <p> It may take a while to receive the most recent location. If
	* an immediate location is required, applications may use the		* an immediate location is required, applications may use the
	* {@link #getLastKnownLocation(String)} method.		* {@link #getLastKnownLocation(String)} method.
	*		*
			* <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
			*
			* <p> In case the provider is disabled by the user, the update will not be received,
			* and the {@link LocationListener#onProviderDisabled(String)}
			* method will be called. As soon as the provider is enabled again,
			* the {@link LocationListener#onProviderEnabled(String)} method will
			* be called and location updates will start again.
			*
	* @param provider the name of the provider with which to register		* @param provider the name of the provider with which to register
	* @param intent a {#link PendingIntent} to be sent for the location update		* @param intent a {#link PendingIntent} to be sent for the location update
	*		*
	@@ -823,16 +823,20 @@ public class LocationManager {
	}		}

	/**		/**
	* Registers the current activity to be notified periodically based on		* Requests a single location update based on the specified criteria.
	* the specified criteria. Periodically, the supplied PendingIntent will
	* be broadcast with the current Location or with status updates.
	*
	* <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
	*		*
	* <p> It may take a while to receive the most recent location. If		* <p> It may take a while to receive the most recent location. If
	* an immediate location is required, applications may use the		* an immediate location is required, applications may use the
	* {@link #getLastKnownLocation(String)} method.		* {@link #getLastKnownLocation(String)} method.
	*		*
			* <p> Location updates are sent with a key of KEY_LOCATION_CHANGED and a Location value.
			*
			* <p> In case the provider is disabled by the user, the update will not be received,
			* and the {@link LocationListener#onProviderDisabled(String)}
			* method will be called. As soon as the provider is enabled again,
			* the {@link LocationListener#onProviderEnabled(String)} method will
			* be called and location updates will start again.
			*
	* @param criteria contains parameters for the location manager to choose the		* @param criteria contains parameters for the location manager to choose the
	* appropriate provider and parameters to compute the location		* appropriate provider and parameters to compute the location
	* @param intent a {#link PendingIntent} to be sent for the location update		* @param intent a {#link PendingIntent} to be sent for the location update