You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by bo...@apache.org on 2014/01/22 20:38:33 UTC

[22/50] [abbrv] git commit: Add javadoc comments to source classes

Add javadoc comments to source classes


Project: http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/commit/eb0aa970
Tree: http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/tree/eb0aa970
Diff: http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/diff/eb0aa970

Branch: refs/heads/master
Commit: eb0aa970c07b59c608a299c54d4d8f04a7063e06
Parents: 20ee58f
Author: Marcel Kinard <cm...@gmail.com>
Authored: Fri Nov 22 17:37:20 2013 -0500
Committer: Joe Bowser <bo...@apache.org>
Committed: Wed Jan 22 11:37:17 2014 -0800

----------------------------------------------------------------------
 .../src/org/apache/cordova/CordovaChromeClient.java      |  8 ++++++++
 framework/src/org/apache/cordova/CordovaWebView.java     | 11 ++++++++++-
 .../src/org/apache/cordova/CordovaWebViewClient.java     |  9 +++++++++
 3 files changed, 27 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/blob/eb0aa970/framework/src/org/apache/cordova/CordovaChromeClient.java
----------------------------------------------------------------------
diff --git a/framework/src/org/apache/cordova/CordovaChromeClient.java b/framework/src/org/apache/cordova/CordovaChromeClient.java
index bc31c66..1ed1a3d 100755
--- a/framework/src/org/apache/cordova/CordovaChromeClient.java
+++ b/framework/src/org/apache/cordova/CordovaChromeClient.java
@@ -49,6 +49,14 @@ import android.widget.RelativeLayout;
 
 /**
  * This class is the AmazonWebChromeClient that implements callbacks for our web view.
+ * The kind of callbacks that happen here are on the chrome outside the document,
+ * such as onCreateWindow(), onConsoleMessage(), onProgressChanged(), etc. Related
+ * to but different than CordovaWebViewClient.
+ *
+ * @see <a href="http://developer.android.com/reference/android/webkit/WebChromeClient.html">WebChromeClient</a>
+ * @see <a href="http://developer.android.com/guide/webapps/webview.html">WebView guide</a>
+ * @see CordovaWebViewClient
+ * @see CordovaWebView
  */
 public class CordovaChromeClient extends AmazonWebChromeClient {
 

http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/blob/eb0aa970/framework/src/org/apache/cordova/CordovaWebView.java
----------------------------------------------------------------------
diff --git a/framework/src/org/apache/cordova/CordovaWebView.java b/framework/src/org/apache/cordova/CordovaWebView.java
index 200e7fe..00eb6d7 100755
--- a/framework/src/org/apache/cordova/CordovaWebView.java
+++ b/framework/src/org/apache/cordova/CordovaWebView.java
@@ -60,6 +60,13 @@ import com.amazon.android.webkit.AmazonWebKitFactory;
 import android.widget.FrameLayout;
 
 public class CordovaWebView extends AmazonWebView {
+/*
+ * This class is our web view.
+ *
+ * @see <a href="http://developer.android.com/guide/webapps/webview.html">WebView guide</a>
+ * @see <a href="http://developer.android.com/reference/android/webkit/WebView.html">WebView</a>
+ */
+
 
     public static final String TAG = "CordovaWebView";
     public static final String CORDOVA_VERSION = "3.3.0-dev";
@@ -267,7 +274,9 @@ public class CordovaWebView extends AmazonWebView {
         this.setup();
     }
 
-
+    /**
+     * set the WebViewClient, but provide special case handling for IceCreamSandwich.
+     */
     private void initWebViewClient(CordovaInterface cordova) {
         if(android.os.Build.VERSION.SDK_INT < android.os.Build.VERSION_CODES.HONEYCOMB ||
                 android.os.Build.VERSION.SDK_INT > android.os.Build.VERSION_CODES.JELLY_BEAN_MR1)

http://git-wip-us.apache.org/repos/asf/cordova-amazon-fireos/blob/eb0aa970/framework/src/org/apache/cordova/CordovaWebViewClient.java
----------------------------------------------------------------------
diff --git a/framework/src/org/apache/cordova/CordovaWebViewClient.java b/framework/src/org/apache/cordova/CordovaWebViewClient.java
index 00ce660..b2abd85 100755
--- a/framework/src/org/apache/cordova/CordovaWebViewClient.java
+++ b/framework/src/org/apache/cordova/CordovaWebViewClient.java
@@ -45,6 +45,15 @@ import com.amazon.android.webkit.AmazonWebViewClient;
 
 /**
  * This class is the AmazonWebViewClient that implements callbacks for our web view.
+ * The kind of callbacks that happen here are regarding the rendering of the
+ * document instead of the chrome surrounding it, such as onPageStarted(), 
+ * shouldOverrideUrlLoading(), etc. Related to but different than
+ * CordovaChromeClient.
+ *
+ * @see <a href="http://developer.android.com/reference/android/webkit/WebViewClient.html">WebViewClient</a>
+ * @see <a href="http://developer.android.com/guide/webapps/webview.html">WebView guide</a>
+ * @see CordovaChromeClient
+ * @see CordovaWebView
  */
 public class CordovaWebViewClient extends AmazonWebViewClient {