Update JavaDoc for CacheManger.CacheResult, WebChromeClient.getDefaultVideoPoster and WebChromeClient.getVideoLoadingProgressView. Do not merge.
This has already been submitted to eclair-mr2.
Change-Id: Ibd184157a90b0031141c91c3b3bbbf4ef86e44e4
diff --git a/core/java/android/webkit/CacheManager.java b/core/java/android/webkit/CacheManager.java
index 75028de..c74092e 100644
--- a/core/java/android/webkit/CacheManager.java
+++ b/core/java/android/webkit/CacheManager.java
@@ -74,6 +74,11 @@
// Flag to clear the cache when the CacheManager is initialized
private static boolean mClearCacheOnInit = false;
+ /**
+ * This class represents a resource retrieved from the HTTP cache.
+ * Instances of this class can be obtained by invoking the
+ * CacheManager.getCacheFile() method.
+ */
public static class CacheResult {
// these fields are saved to the database
int httpStatusCode;
diff --git a/core/java/android/webkit/WebChromeClient.java b/core/java/android/webkit/WebChromeClient.java
index 92676aa..c484442 100644
--- a/core/java/android/webkit/WebChromeClient.java
+++ b/core/java/android/webkit/WebChromeClient.java
@@ -265,20 +265,25 @@
public void addMessageToConsole(String message, int lineNumber, String sourceID) {}
/**
- * Ask the host application for an icon to represent a <video> element.
- * This icon will be used if the Web page did not specify a poster attribute.
+ * When not playing, video elements are represented by a 'poster' image. The
+ * image to use can be specified by the poster attribute of the video tag in
+ * HTML. If the attribute is absent, then a default poster will be used. This
+ * method allows the ChromeClient to provide that default image.
*
- * @return Bitmap The icon or null if no such icon is available.
+ * @return Bitmap The image to use as a default poster, or null if no such image is
+ * available.
*/
public Bitmap getDefaultVideoPoster() {
return null;
}
/**
- * Ask the host application for a custom progress view to show while
- * a <video> is loading.
+ * When the user starts to playback a video element, it may take time for enough
+ * data to be buffered before the first frames can be rendered. While this buffering
+ * is taking place, the ChromeClient can use this function to provide a View to be
+ * displayed. For example, the ChromeClient could show a spinner animation.
*
- * @return View The progress view.
+ * @return View The View to be displayed whilst the video is loading.
*/
public View getVideoLoadingProgressView() {
return null;
