Clean up JavaDoc for GeolocationPermissions
Much of the current JavaDoc for GeolocationPermissions exposes implementation
details which are of no interest to a Java developer. Move these comments out
of the JavaDoc and clean up the text.
Bug: 5461416
Change-Id: I95a68fe15016fadc729d8d857fd69b2c927a5ea9
diff --git a/core/java/android/webkit/WebChromeClient.java b/core/java/android/webkit/WebChromeClient.java
index 3d129f7..a6ef0ce 100644
--- a/core/java/android/webkit/WebChromeClient.java
+++ b/core/java/android/webkit/WebChromeClient.java
@@ -250,14 +250,24 @@
}
/**
- * Instructs the client to show a prompt to ask the user to set the
- * Geolocation permission state for the specified origin.
+ * Notify the host application that web content from the specified origin
+ * is attempting to use the Geolocation API, but no permission state is
+ * currently set for that origin. The host application should invoke the
+ * specified callback with the desired permission state. See
+ * {@link GeolocationPermissions} for details.
+ * @param origin The origin of the web content attempting to use the
+ * Geolocation API.
+ * @param callback The callback to use to set the permission state for the
+ * origin.
*/
public void onGeolocationPermissionsShowPrompt(String origin,
GeolocationPermissions.Callback callback) {}
/**
- * Instructs the client to hide the Geolocation permissions prompt.
+ * Notify the host application that a request for Geolocation permissions,
+ * made with a previous call to
+ * {@link #onGeolocationPermissionsShowPrompt(String,GeolocationPermissions.Callback) onGeolocationPermissionsShowPrompt()}
+ * has been canceled. Any related UI should therefore be hidden.
*/
public void onGeolocationPermissionsHidePrompt() {}