Title: [100642] trunk/Source/WebKit/gtk
- Revision
- 100642
- Author
- [email protected]
- Date
- 2011-11-17 10:24:44 -0800 (Thu, 17 Nov 2011)
Log Message
[GTK] Remove the last remaining WebKit1 gtkdoc warnings
https://bugs.webkit.org/show_bug.cgi?id=72627
Reviewed by Philippe Normand.
* webkit/webkitdownload.h: Add missing enum documentation.
* webkit/webkiterror.h: Ditto.
* webkit/webkitwebview.h: Ditto.
Modified Paths
Diff
Modified: trunk/Source/WebKit/gtk/ChangeLog (100641 => 100642)
--- trunk/Source/WebKit/gtk/ChangeLog 2011-11-17 18:07:29 UTC (rev 100641)
+++ trunk/Source/WebKit/gtk/ChangeLog 2011-11-17 18:24:44 UTC (rev 100642)
@@ -1,3 +1,14 @@
+2011-11-17 Martin Robinson <[email protected]>
+
+ [GTK] Remove the last remaining WebKit1 gtkdoc warnings
+ https://bugs.webkit.org/show_bug.cgi?id=72627
+
+ Reviewed by Philippe Normand.
+
+ * webkit/webkitdownload.h: Add missing enum documentation.
+ * webkit/webkiterror.h: Ditto.
+ * webkit/webkitwebview.h: Ditto.
+
2011-11-17 Mario Sanchez Prada <[email protected]>
[Gtk] Ensure the parent for the webView's a11y object is set.
Modified: trunk/Source/WebKit/gtk/webkit/webkitdownload.h (100641 => 100642)
--- trunk/Source/WebKit/gtk/webkit/webkitdownload.h 2011-11-17 18:07:29 UTC (rev 100641)
+++ trunk/Source/WebKit/gtk/webkit/webkitdownload.h 2011-11-17 18:24:44 UTC (rev 100642)
@@ -34,6 +34,16 @@
#define WEBKIT_IS_DOWNLOAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), WEBKIT_TYPE_DOWNLOAD))
#define WEBKIT_DOWNLOAD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), WEBKIT_TYPE_DOWNLOAD, WebKitDownloadClass))
+/**
+ * WebKitDownloadStatus:
+ * @WEBKIT_DOWNLOAD_STATUS_ERROR: The download failed because of an error other than user cancellation.
+ * @WEBKIT_DOWNLOAD_STATUS_CREATED: The download has not started yet.
+ * @WEBKIT_DOWNLOAD_STATUS_STARTED: The download has started, but has not completed yet.
+ * @WEBKIT_DOWNLOAD_STATUS_CANCELLED: The user canceled the download.
+ * @WEBKIT_DOWNLOAD_STATUS_FINISHED: The download completed successfully.
+ *
+ * Enum values used to denote the various states of a download.
+ **/
typedef enum {
WEBKIT_DOWNLOAD_STATUS_ERROR = -1,
WEBKIT_DOWNLOAD_STATUS_CREATED = 0,
@@ -42,6 +52,14 @@
WEBKIT_DOWNLOAD_STATUS_FINISHED
} WebKitDownloadStatus;
+/**
+ * WebKitDownloadError:
+ * @WEBKIT_DOWNLOAD_ERROR_CANCELLED_BY_USER: The download failed due to user cancellation.
+ * @WEBKIT_DOWNLOAD_ERROR_DESTINATION: The download failed due to disk write failure.
+ * @WEBKIT_DOWNLOAD_ERROR_NETWORK: The download failed due to a network error.
+ *
+ * Enum values used to denote the various download errors.
+ **/
typedef enum {
WEBKIT_DOWNLOAD_ERROR_CANCELLED_BY_USER,
WEBKIT_DOWNLOAD_ERROR_DESTINATION,
Modified: trunk/Source/WebKit/gtk/webkit/webkiterror.h (100641 => 100642)
--- trunk/Source/WebKit/gtk/webkit/webkiterror.h 2011-11-17 18:07:29 UTC (rev 100641)
+++ trunk/Source/WebKit/gtk/webkit/webkiterror.h 2011-11-17 18:24:44 UTC (rev 100642)
@@ -30,6 +30,18 @@
#define WEBKIT_POLICY_ERROR webkit_policy_error_quark ()
#define WEBKIT_PLUGIN_ERROR webkit_plugin_error_quark ()
+/* The enum values are synchronized with Mac's WebKit error values. */
+
+/**
+ * WebKitNetworkError:
+ * @WEBKIT_NETWORK_ERROR_FAILED: Generic load failure
+ * @WEBKIT_NETWORK_ERROR_TRANSPORT: Load failure due to transport error
+ * @WEBKIT_NETWORK_ERROR_UNKNOWN_PROTOCOL: Load failure due to unknown protocol
+ * @WEBKIT_NETWORK_ERROR_CANCELLED: Load failure due to cancellation
+ * @WEBKIT_NETWORK_ERROR_FILE_DOES_NOT_EXIST: Load failure due to missing file
+ *
+ * Enum values used to denote the various network errors.
+ **/
typedef enum {
WEBKIT_NETWORK_ERROR_FAILED = 399,
WEBKIT_NETWORK_ERROR_TRANSPORT = 300,
@@ -38,7 +50,16 @@
WEBKIT_NETWORK_ERROR_FILE_DOES_NOT_EXIST = 303,
} WebKitNetworkError;
-/* Sync'd with Mac's WebKit Errors */
+/**
+ * WebKitPolicyError:
+ * @WEBKIT_POLICY_ERROR_FAILED: Generic load failure due to policy error
+ * @WEBKIT_POLICY_ERROR_CANNOT_SHOW_MIME_TYPE: Load failure due to unsupported mime type
+ * @WEBKIT_POLICY_ERROR_CANNOT_SHOW_URL: Load failure due to URI that can not be shown
+ * @WEBKIT_POLICY_ERROR_FRAME_LOAD_INTERRUPTED_BY_POLICY_CHANGE: Load failure due to frame load interruption by policy change
+ * @WEBKIT_POLICY_ERROR_CANNOT_USE_RESTRICTED_PORT: Load failure due to port restriction
+ *
+ * Enum values used to denote the various policy errors.
+ **/
typedef enum {
WEBKIT_POLICY_ERROR_FAILED = 199,
WEBKIT_POLICY_ERROR_CANNOT_SHOW_MIME_TYPE = 100,
@@ -47,6 +68,17 @@
WEBKIT_POLICY_ERROR_CANNOT_USE_RESTRICTED_PORT = 103,
} WebKitPolicyError;
+/**
+ * WebKitPluginError:
+ * @WEBKIT_PLUGIN_ERROR_FAILED: Generic plugin load failure
+ * @WEBKIT_PLUGIN_ERROR_CANNOT_FIND_PLUGIN: Load failure due to missing plugin
+ * @WEBKIT_PLUGIN_ERROR_CANNOT_LOAD_PLUGIN: Load failure due to inability to load plugin
+ * @WEBKIT_PLUGIN_ERROR_JAVA_UNAVAILABLE: Load failue due to missing Java support that is required to load plugin
+ * @WEBKIT_PLUGIN_ERROR_CONNECTION_CANCELLED: Load failure due to connection cancellation
+ * @WEBKIT_PLUGIN_ERROR_WILL_HANDLE_LOAD: Load failure since plugin handles the load
+ *
+ * Enum values used to denote the various plugin errors.
+ **/
typedef enum {
WEBKIT_PLUGIN_ERROR_FAILED = 299,
WEBKIT_PLUGIN_ERROR_CANNOT_FIND_PLUGIN = 200,
Modified: trunk/Source/WebKit/gtk/webkit/webkitwebview.h (100641 => 100642)
--- trunk/Source/WebKit/gtk/webkit/webkitwebview.h 2011-11-17 18:07:29 UTC (rev 100641)
+++ trunk/Source/WebKit/gtk/webkit/webkitwebview.h 2011-11-17 18:24:44 UTC (rev 100642)
@@ -44,12 +44,31 @@
typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
+/**
+ * WebKitNavigationResponse:
+ * @WEBKIT_NAVIGATION_RESPONSE_ACCEPT: Instruct WebKit to allow the navigation.
+ * @WEBKIT_NAVIGATION_RESPONSE_IGNORE: Instruct WebKit to ignore the navigation.
+ * @WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD: Instruct WebKit to start a download of the destination instead.
+ *
+ * Enum values used to denote the various responses to a navigation policy decision.
+ **/
typedef enum {
WEBKIT_NAVIGATION_RESPONSE_ACCEPT,
WEBKIT_NAVIGATION_RESPONSE_IGNORE,
WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD
} WebKitNavigationResponse;
+/**
+ * WebKitWebViewTargetInfo:
+ * @WEBKIT_WEB_VIEW_TARGET_INFO_HTML: Rich markup data
+ * @WEBKIT_WEB_VIEW_TARGET_INFO_TEXT: Text data
+ * @WEBKIT_WEB_VIEW_TARGET_INFO_IMAGE: Image data
+ * @WEBKIT_WEB_VIEW_TARGET_INFO_URI_LIST: URI list data
+ * @WEBKIT_WEB_VIEW_TARGET_INFO_NETSCAPE_URL: A single URL in the Netscape protocol
+ *
+ * Enum values used to denote the info value of various selection types. These can be used
+ * to interpret the data WebKitGTK+ publishes via GtkClipboard and drag-and-drop.
+ **/
typedef enum
{
WEBKIT_WEB_VIEW_TARGET_INFO_HTML,
@@ -59,6 +78,17 @@
WEBKIT_WEB_VIEW_TARGET_INFO_NETSCAPE_URL
} WebKitWebViewTargetInfo;
+/**
+ * WebKitWebViewViewMode:
+ * @WEBKIT_WEB_VIEW_VIEW_MODE_WINDOWED: Windowed view mode
+ * @WEBKIT_WEB_VIEW_VIEW_MODE_FLOATING: Floating view mode
+ * @WEBKIT_WEB_VIEW_VIEW_MODE_FULLSCREEN: Fullscreen view mode
+ * @WEBKIT_WEB_VIEW_VIEW_MODE_MAXIMIZED: Maximized view mode
+ * @WEBKIT_WEB_VIEW_VIEW_MODE_MINIMIZED: Minimized view mode
+ *
+ * Enum values used to denote the various types of view modes. See the
+ * #WebKitWebView:view-mode property.
+ **/
typedef enum
{
WEBKIT_WEB_VIEW_VIEW_MODE_WINDOWED,
_______________________________________________
webkit-changes mailing list
[email protected]
http://lists.webkit.org/mailman/listinfo.cgi/webkit-changes
