[webkit-changes] [88734] trunk/Source/WebKit/gtk

Mon, 13 Jun 2011 17:10:39 -0700

Title: [88734] trunk/Source/WebKit/gtk
Revision
88734
Author
[email protected]
Date
2011-06-13 17:09:47 -0700 (Mon, 13 Jun 2011)

Log Message

2011-06-13  Martin Robinson  <[email protected]>

        Reviewed by Gustavo Noronha Silva.

        Update gtkdoc files and inline documentation to reduce gtkdoc errors
        and ensure complete documentation output.

        * docs/webkitgtk-sections.txt: Add missing sections to the list and remove
        unneeded sections.
        * docs/webkitgtk.types: Update the types list.
        * webkit/webkithittestresult.cpp: Fix inline documentation errors.
        (webkit_hit_test_result_class_init): Ditto.
        * webkit/webkiticondatabase.cpp: Ditto.
        * webkit/webkitwebsettings.cpp: Ditto.
        (webkit_web_settings_class_init): Ditto.
        * webkit/webkitwebview.cpp: Ditto.
        (webkit_web_view_class_init): Ditto.

Modified Paths

Diff

Modified: trunk/Source/WebKit/gtk/ChangeLog (88733 => 88734)


--- trunk/Source/WebKit/gtk/ChangeLog	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/ChangeLog	2011-06-14 00:09:47 UTC (rev 88734)
@@ -1,5 +1,23 @@
 2011-06-13  Martin Robinson  <[email protected]>
 
+        Reviewed by Gustavo Noronha Silva.
+
+        Update gtkdoc files and inline documentation to reduce gtkdoc errors
+        and ensure complete documentation output.
+
+        * docs/webkitgtk-sections.txt: Add missing sections to the list and remove
+        unneeded sections.
+        * docs/webkitgtk.types: Update the types list.
+        * webkit/webkithittestresult.cpp: Fix inline documentation errors.
+        (webkit_hit_test_result_class_init): Ditto.
+        * webkit/webkiticondatabase.cpp: Ditto.
+        * webkit/webkitwebsettings.cpp: Ditto.
+        (webkit_web_settings_class_init): Ditto.
+        * webkit/webkitwebview.cpp: Ditto.
+        (webkit_web_view_class_init): Ditto.
+
+2011-06-13  Martin Robinson  <[email protected]>
+
         Reviewed by Xan Lopez.
 
         Update the list of ignored GTK+ header files for the documentation

Modified: trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt (88733 => 88734)


--- trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt	2011-06-14 00:09:47 UTC (rev 88734)
@@ -1,8 +1,8 @@
 <SECTION>
 <FILE>webkitwebsettings</FILE>
 <TITLE>WebKitWebSettings</TITLE>
-WebKitEditingBehavior
 WebKitWebSettings
+WebKitEditingBehavior
 webkit_web_settings_copy
 webkit_web_settings_new
 webkit_web_settings_get_user_agent
@@ -14,10 +14,8 @@
 WEBKIT_IS_WEB_SETTINGS_CLASS
 WEBKIT_WEB_SETTINGS_GET_CLASS
 <SUBSECTION Private>
-webkit_web_settings_get_type
-WebKitWebSettingsPrivate
-WebKitWebSettings
 WebKitWebSettingsClass
+webkit_web_settings_get_type
 </SECTION>
 
 <SECTION>
@@ -51,7 +49,6 @@
 <SUBSECTION Private>
 WebKitWebBackForwardListPrivate
 webkit_web_back_forward_list_get_type
-WebKitWebBackForwardList
 WebKitWebBackForwardListClass
 </SECTION>
 
@@ -78,7 +75,6 @@
 <SUBSECTION Private>
 webkit_web_history_item_get_type
 WebKitWebHistoryItemPrivate
-WebKitWebHistoryItem
 WebKitWebHistoryItemClass
 </SECTION>
 
@@ -120,7 +116,6 @@
 <SUBSECTION Private>
 WebKitWebFramePrivate
 webkit_web_frame_get_type
-WebKitWebFrame
 WebKitWebFrameClass
 </SECTION>
 
@@ -153,7 +148,6 @@
 WEBKIT_TYPE_DOWNLOAD
 <SUBSECTION Private>
 webkit_download_get_type
-WebKitDownload
 WebKitDownloadClass
 WebKitDownloadPrivate
 </SECTION>
@@ -178,7 +172,6 @@
 WEBKIT_IS_SECURITY_ORIGIN_CLASS
 WEBKIT_TYPE_SECURITY_ORIGIN
 <SUBSECTION Private>
-WebKitSecurityOrigin
 WebKitSecurityOriginClass
 WebKitSecurityOriginPrivate
 </SECTION>
@@ -196,9 +189,7 @@
 WEBKIT_IS_HIT_TEST_RESULT_CLASS
 WEBKIT_TYPE_HIT_TEST_RESULT
 <SUBSECTION Private>
-WebKitHitTestResult
 WebKitHitTestResultClass
-WebKitHitTestResultContext
 WebKitHitTestResultPrivate
 webkit_hit_test_result_get_type
 </SECTION>
@@ -225,7 +216,6 @@
 WEBKIT_WEB_DATA_SOURCE_CLASS
 WEBKIT_WEB_DATA_SOURCE_GET_CLASS
 <SUBSECTION Private>
-WebKitWebDataSource
 WebKitWebDataSourceClass
 WebKitWebDataSourcePrivate
 webkit_web_data_source_new_with_request
@@ -251,7 +241,6 @@
 WEBKIT_WEB_DATABASE_CLASS
 WEBKIT_WEB_DATABASE_GET_CLASS
 <SUBSECTION Private>
-WebKitWebDatabase
 WebKitWebDatabaseClass
 WebKitWebDatabasePrivate
 webkit_web_database_get_type
@@ -270,7 +259,6 @@
 WEBKIT_TYPE_SOUP_AUTH_DIALOG
 <SUBSECTION Private>
 webkit_soup_auth_dialog_get_type
-WebKitSoupAuthDialog
 WebKitSoupAuthDialogClass
 </SECTION>
 
@@ -293,7 +281,6 @@
 <SUBSECTION Private>
 webkit_web_inspector_get_type
 WebKitWebInspectorPrivate
-WebKitWebInspector
 WebKitWebInspectorClass
 </SECTION>
 
@@ -318,7 +305,6 @@
 WEBKIT_WEB_NAVIGATION_ACTION_CLASS
 WEBKIT_WEB_NAVIGATION_ACTION_GET_CLASS
 <SUBSECTION Private>
-WebKitWebNavigationAction
 WebKitWebNavigationActionClass
 WebKitWebNavigationActionPrivate
 </SECTION>
@@ -339,7 +325,6 @@
 WEBKIT_WEB_POLICY_DECISION_CLASS
 WEBKIT_WEB_POLICY_DECISION_GET_CLASS
 <SUBSECTION Private>
-WebKitWebPolicyDecision
 WebKitWebPolicyDecisionClass
 WebKitWebPolicyDecisionPrivate
 </SECTION>
@@ -359,7 +344,6 @@
 WEBKIT_GEOLOCATION_POLICY_DECISION_CLASS
 WEBKIT_GEOLOCATION_POLICY_DECISION_GET_CLASS
 <SUBSECTION Private>
-WebKitGeolocationPolicyDecision
 WebKitGeolocationPolicyDecisionClass
 WebKitGeolocationPolicyDecisionPrivate
 </SECTION>
@@ -382,7 +366,6 @@
 <SUBSECTION Private>
 webkit_network_request_get_type
 WebKitNetworkRequestPrivate
-WebKitNetworkRequest
 WebKitNetworkRequestClass
 </SECTION>
 
@@ -404,7 +387,6 @@
 webkit_network_response_get_type
 webkit_network_response_new
 WebKitNetworkResponsePrivate
-WebKitNetworkResponse
 WebKitNetworkResponseClass
 </SECTION>
 
@@ -496,9 +478,7 @@
 <SUBSECTION Private>
 webkit_web_view_get_type
 WebKitWebViewPrivate
-WebKitWebView
 WebKitWebViewClass
-WEBKIT_WEB_VIEW_GET_PRIVATE
 </SECTION>
 
 <SECTION>
@@ -516,7 +496,6 @@
 WEBKIT_WEB_WINDOW_FEATURES_GET_CLASS
 <SUBSECTION Private>
 webkit_web_window_features_get_type
-WebKitWebWindowFeatures
 WebKitWebWindowFeaturesClass
 WebKitWebWindowFeaturesPrivate
 </SECTION>
@@ -556,16 +535,14 @@
 WEBKIT_IS_WEB_RESOURCE_CLASS
 WEBKIT_WEB_RESOURCE_GET_CLASS
 <SUBSECTION Private>
-webkit_web_resource_get_type
-webkit_web_resource_new
 WebKitWebResourcePrivate
-WebKitWebResource
 WebKitWebResourceClass
 </SECTION>
 
 <SECTION>
 <FILE>webkitviewportattributes</FILE>
 <TITLE>WebKitViewportAttributes</TITLE>
+WebKitViewportAttributes
 webkit_viewport_attributes_recompute
 <SUBSECTION Standard>
 WEBKIT_IS_VIEWPORT_ATTRIBUTES
@@ -576,7 +553,6 @@
 WEBKIT_VIEWPORT_ATTRIBUTES_GET_CLASS
 <SUBSECTION Private>
 webkit_viewport_attributes_get_type
-WebKitViewportAttributes
 WebKitViewportAttributesClass
 WebKitViewportAttributesPrivate
 </SECTION>
@@ -584,12 +560,14 @@
 <SECTION>
 <FILE>webkitwebplugin</FILE>
 <TITLE>WebKitWebPlugin</TITLE>
+WebKitWebPlugin
 WebKitWebPluginMIMEType
 webkit_web_plugin_get_description
 webkit_web_plugin_get_enabled
 webkit_web_plugin_get_mimetypes
 webkit_web_plugin_get_name
 webkit_web_plugin_set_enabled
+webkit_web_plugin_get_path
 <SUBSECTION Standard>
 WEBKIT_IS_WEB_PLUGIN
 WEBKIT_IS_WEB_PLUGIN_CLASS
@@ -599,7 +577,6 @@
 WEBKIT_WEB_PLUGIN_GET_CLASS
 <SUBSECTION Private>
 webkit_web_plugin_get_type
-WebKitWebPlugin
 WebKitWebPluginClass
 WebKitWebPluginPrivate
 </SECTION>
@@ -607,9 +584,9 @@
 <SECTION>
 <FILE>webkitwebplugindatabase</FILE>
 <TITLE>WebKitWebPluginDatabase</TITLE>
+WebKitWebPluginDatabase
 webkit_web_plugin_database_get_plugin_for_mimetype
 webkit_web_plugin_database_get_plugins
-webkit_web_plugin_database_new
 webkit_web_plugin_database_plugins_list_free
 webkit_web_plugin_database_refresh
 <SUBSECTION Standard>
@@ -620,25 +597,12 @@
 WEBKIT_WEB_PLUGIN_DATABASE_CLASS
 WEBKIT_WEB_PLUGIN_DATABASE_GET_CLASS
 <SUBSECTION Private>
-WebKitWebPluginDatabase
 WebKitWebPluginDatabaseClass
 WebKitWebPluginDatabasePrivate
 webkit_web_plugin_database_get_type
 </SECTION>
 
 <SECTION>
-<FILE>webkitprivate</FILE>
-getViewFromFrame
-kit
-WEBKIT_PARAM_READABLE
-WEBKIT_PARAM_READWRITE
-webkit_web_history_item_new_with_core_item
-webkit_web_inspector_set_inspector_client
-webkit_web_inspector_set_web_view
-webkit_web_inspector_set_inspected_uri
-</SECTION>
-
-<SECTION>
 <FILE>webkiterror</FILE>
 WEBKIT_NETWORK_ERROR
 WEBKIT_PLUGIN_ERROR

Modified: trunk/Source/WebKit/gtk/docs/webkitgtk.types (88733 => 88734)


--- trunk/Source/WebKit/gtk/docs/webkitgtk.types	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/docs/webkitgtk.types	2011-06-14 00:09:47 UTC (rev 88734)
@@ -1,13 +1,24 @@
 #include <webkit/webkit.h>
-
 webkit_download_get_type
-webkit_navigation_response_get_type
+webkit_geolocation_policy_decision_get_type
+webkit_hit_test_result_get_type
+webkit_icon_database_get_type
 webkit_network_request_get_type
+webkit_network_response_get_type
+webkit_security_origin_get_type
+webkit_soup_auth_dialog_get_type
+webkit_viewport_attributes_get_type
 webkit_web_back_forward_list_get_type
+webkit_web_database_get_type
+webkit_web_data_source_get_type
+webkit_web_frame_get_type
 webkit_web_history_item_get_type
 webkit_web_inspector_get_type
+webkit_web_navigation_action_get_type
+webkit_web_plugin_database_get_type
+webkit_web_plugin_get_type
+webkit_web_policy_decision_get_type
+webkit_web_resource_get_type
 webkit_web_settings_get_type
 webkit_web_view_get_type
-webkit_web_view_target_info_get_type
 webkit_web_window_features_get_type
-

Modified: trunk/Source/WebKit/gtk/webkit/webkithittestresult.cpp (88733 => 88734)


--- trunk/Source/WebKit/gtk/webkit/webkithittestresult.cpp	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/webkit/webkithittestresult.cpp	2011-06-14 00:09:47 UTC (rev 88734)
@@ -211,7 +211,7 @@
      * representative of the information given in the context
      * property, since WebKit uses a series of heuristics to figure
      * out that information. One common example is inner-node having
-     * the text node inside the anchor (<a>) tag; WebKit knows the
+     * the text node inside the anchor (&lt;a&gt;) tag; WebKit knows the
      * whole context and will put WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK
      * in the 'context' property, but the user might be confused by
      * the lack of any link tag in 'inner-node'.

Modified: trunk/Source/WebKit/gtk/webkit/webkiticondatabase.cpp (88733 => 88734)


--- trunk/Source/WebKit/gtk/webkit/webkiticondatabase.cpp	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/webkit/webkiticondatabase.cpp	2011-06-14 00:09:47 UTC (rev 88734)
@@ -301,7 +301,7 @@
 }
 
 /**
- * webkit_icon_database_clear():
+ * webkit_icon_database_clear:
  * @database: a #WebKitIconDatabase
  *
  * Clears all icons from the database.

Modified: trunk/Source/WebKit/gtk/webkit/webkitwebsettings.cpp (88733 => 88734)


--- trunk/Source/WebKit/gtk/webkit/webkitwebsettings.cpp	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/webkit/webkitwebsettings.cpp	2011-06-14 00:09:47 UTC (rev 88734)
@@ -894,7 +894,7 @@
     /**
     * WebKitWebSettings:enable-hyperlink-auditing:
     *
-    * Enable or disable support for <a ping>.
+    * Enable or disable support for &lt;a ping&gt;.
     *
     * Since: 1.2.5
     */
@@ -1315,6 +1315,7 @@
 
 /**
  * webkit_web_settings_copy:
+ * @web_settings: a #WebKitWebSettings to copy.
  *
  * Copies an existing #WebKitWebSettings instance.
  *
@@ -1396,7 +1397,7 @@
  * webkit_web_settings_get_user_agent:
  * @web_settings: a #WebKitWebSettings
  *
- * Returns the User-Agent string currently used by the web view(s) associated
+ * Returns: the User-Agent string currently used by the web view(s) associated
  * with the @web_settings.
  *
  * Since: 1.1.11

Modified: trunk/Source/WebKit/gtk/webkit/webkitwebview.cpp (88733 => 88734)


--- trunk/Source/WebKit/gtk/webkit/webkitwebview.cpp	2011-06-13 23:51:21 UTC (rev 88733)
+++ trunk/Source/WebKit/gtk/webkit/webkitwebview.cpp	2011-06-14 00:09:47 UTC (rev 88734)
@@ -2914,7 +2914,7 @@
     /**
     * WebKitWebView:title:
     *
-    * Returns the @web_view's document title.
+    * Returns: the @web_view's document title.
     *
     * Since: 1.1.4
     */
@@ -2928,7 +2928,7 @@
     /**
     * WebKitWebView:uri:
     *
-    * Returns the current URI of the contents displayed by the @web_view.
+    * Returns: the current URI of the contents displayed by the @web_view.
     *
     * Since: 1.1.4
     */
@@ -3607,12 +3607,12 @@
  *
  * Obtains the #WebKitViewportAttributes associated with the
  * #WebKitWebView. Every #WebKitWebView object has a
- * #WebKitWebViewporAttributes object attached to it as soon as it is
+ * #WebKitViewportAttributes object attached to it as soon as it is
  * created, so this function will only return NULL if the argument is
  * not a valid #WebKitWebView. Do note however that the viewport
  * attributes object only contains valid information when the current
  * page has a viewport meta tag. You can check whether the data should
- * be used by checking the #WebKitViewport:valid property.
+ * be used by checking the #WebKitViewportAttributes:valid property.
  *
  * Return value: (transfer none): the #WebKitViewportAttributes instance.
  *
@@ -3638,7 +3638,7 @@
  * webkit_web_view_get_window_features:
  * @webView: a #WebKitWebView
  *
- * Returns the instance of #WebKitWebWindowFeatures held by the given
+ * Returns: the instance of #WebKitWebWindowFeatures held by the given
  * #WebKitWebView.
  *
  * Return value: (transfer none): the #WebKitWebWindowFeatures

_______________________________________________
webkit-changes mailing list
[email protected]
http://lists.webkit.org/mailman/listinfo.cgi/webkit-changes

Reply via email to