Skip to content

Commit 28f8889

Browse files
committed
Fix doc comments to correspond to the method
1 parent 5ed43ab commit 28f8889

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebSettingsCompatProxyApi.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010
import androidx.webkit.WebViewFeature;
1111

1212
/**
13-
* Host api implementation for {@link WebSettingsCompat}.
13+
* Proxy API implementation for {@link WebSettingsCompat}.
1414
*
15-
* <p>Handles static methods for {@link WebSettingsCompat}.
15+
* <p>This class may handle instantiating and adding native object instances that are attached to a
16+
* Dart instance or handle method calls on the associated native class or an instance of the class.
1617
*/
1718
public class WebSettingsCompatProxyApi extends PigeonApiWebSettingsCompat {
1819
public WebSettingsCompatProxyApi(@NonNull ProxyApiRegistrar pigeonRegistrar) {

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewFeatureProxyApi.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88
import androidx.webkit.WebViewFeature;
99

1010
/**
11-
* Host api implementation for {@link WebViewFeature}.
11+
* Proxy API implementation for {@link WebViewFeature}.
1212
*
13-
* <p>Handles creating {@link WebViewFeature}s that intercommunicate with a paired Dart object.
13+
* <p>This class may handle instantiating and adding native object instances that are attached to a
14+
* Dart instance or handle method calls on the associated native class or an instance of the class.
1415
*/
1516
public class WebViewFeatureProxyApi extends PigeonApiWebViewFeature {
1617
public WebViewFeatureProxyApi(@NonNull ProxyApiRegistrar pigeonRegistrar) {

packages/webview_flutter/webview_flutter_android/lib/src/android_webview_controller.dart

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -804,6 +804,9 @@ class AndroidWebViewController extends PlatformWebViewController {
804804
///
805805
/// Before calling this method, you should check if the feature is supported using
806806
/// [isWebViewFeatureSupported] with [WebViewFeatureConstants.paymentRequest].
807+
///
808+
/// This feature requires adding queries to the AndroidManifest.xml to allow WebView to query the device for the user's payment applications:
809+
/// See https://developer.android.com/reference/androidx/webkit/WebSettingsCompat#setPaymentRequestEnabled(android.webkit.WebSettings,boolean).
807810
Future<void> setPaymentRequestEnabled(bool enabled) {
808811
return _androidWebViewParams.androidWebViewProxy.setPaymentRequestEnabled(
809812
_webView.settings,
@@ -938,9 +941,13 @@ enum MixedContentMode {
938941
neverAllow,
939942
}
940943

944+
/// WebView support library feature types used to query for support on the device.
945+
///
941946
/// See https://developer.android.com/reference/androidx/webkit/WebViewFeature#constants_1.
942947
enum WebViewFeatureType {
943-
/// Feature for isFeatureSupported. This feature covers [WebSettingsCompat.setPaymentRequestEnabled].
948+
/// Feature for isFeatureSupported.
949+
///
950+
/// This feature covers [WebSettingsCompat.setPaymentRequestEnabled].
944951
paymentRequest,
945952
}
946953

packages/webview_flutter/webview_flutter_android/pigeons/android_webkit.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,6 +1092,9 @@ abstract class Certificate {
10921092
Uint8List getEncoded();
10931093
}
10941094

1095+
/// Compatibility version of `WebSettings`.
1096+
///
1097+
/// See https://developer.android.com/reference/kotlin/androidx/webkit/WebSettingsCompat.
10951098
@ProxyApi(
10961099
kotlinOptions: KotlinProxyApiOptions(
10971100
fullClassName: 'androidx.webkit.WebSettingsCompat',
@@ -1105,6 +1108,9 @@ abstract class WebSettingsCompat {
11051108
);
11061109
}
11071110

1111+
/// Utility class for checking which WebView Support Library features are supported on the device.
1112+
///
1113+
/// See https://developer.android.com/reference/kotlin/androidx/webkit/WebViewFeature.
11081114
@ProxyApi(
11091115
kotlinOptions: KotlinProxyApiOptions(
11101116
fullClassName: 'androidx.webkit.WebViewFeature',

0 commit comments

Comments
 (0)