From 23fab938b0a31d8755209bc4effab390a9f1f60d Mon Sep 17 00:00:00 2001
From: Holger Freyther <ich@tamarin.(none)>
Date: Sat, 22 Nov 2008 02:24:38 +0100
Subject: [PATCH] [Gtk+] Make gtk-doc happy with the existing API documentation

    - Mark the *Private pointers in the struct private
    - Use Returns: where gtk-doc wants us to
    - Fix the parameters to make gtk-doc happy
---
 WebKit/gtk/webkit/webkitnetworkrequest.h       |    1 +
 WebKit/gtk/webkit/webkitwebbackforwardlist.cpp |   40 ++++++++++++------------
 WebKit/gtk/webkit/webkitwebbackforwardlist.h   |    1 +
 WebKit/gtk/webkit/webkitwebframe.h             |    2 +
 WebKit/gtk/webkit/webkitwebhistoryitem.cpp     |   30 +++++++++---------
 WebKit/gtk/webkit/webkitwebview.cpp            |    8 ++--
 WebKit/gtk/webkit/webkitwebview.h              |    4 ++-
 7 files changed, 46 insertions(+), 40 deletions(-)

diff --git a/WebKit/gtk/webkit/webkitnetworkrequest.h b/WebKit/gtk/webkit/webkitnetworkrequest.h
index dfb4d6c..a1475bb 100644
--- a/WebKit/gtk/webkit/webkitnetworkrequest.h
+++ b/WebKit/gtk/webkit/webkitnetworkrequest.h
@@ -38,6 +38,7 @@ typedef struct _WebKitNetworkRequestPrivate WebKitNetworkRequestPrivate;
 struct _WebKitNetworkRequest {
     GObject parent_instance;
 
+    /*< private >*/
     WebKitNetworkRequestPrivate *priv;
 };
 
diff --git a/WebKit/gtk/webkit/webkitwebbackforwardlist.cpp b/WebKit/gtk/webkit/webkitwebbackforwardlist.cpp
index ff68dad..f0d6a79 100644
--- a/WebKit/gtk/webkit/webkitwebbackforwardlist.cpp
+++ b/WebKit/gtk/webkit/webkitwebbackforwardlist.cpp
@@ -53,7 +53,7 @@ static void webkit_web_back_forward_list_init(WebKitWebBackForwardList* webBackF
 
 /**
  * webkit_web_back_forward_list_new_with_web_view:
- * @webView: the back forward list's #WebKitWebView
+ * @web_view: the back forward list's #WebKitWebView
  *
  * Creates an instance of the back forward list with a controlling #WebKitWebView
  *
@@ -76,7 +76,7 @@ WebKitWebBackForwardList* webkit_web_back_forward_list_new_with_web_view(WebKitW
 
 /**
  * webkit_web_back_forward_list_go_forward:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Steps forward in the back forward list
  */
@@ -91,7 +91,7 @@ void webkit_web_back_forward_list_go_forward(WebKitWebBackForwardList* webBackFo
 
 /**
  * webkit_web_back_forward_list_go_back:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Steps backward in the back forward list
  */
@@ -106,12 +106,12 @@ void webkit_web_back_forward_list_go_back(WebKitWebBackForwardList* webBackForwa
 
 /**
  * webkit_web_back_forward_list_contains_item:
- * @webBackForwardList: a #WebKitWebBackForwardList
- * @webHistoryItem: the #WebKitWebHistoryItem to check
+ * @web_back_forward_list: a #WebKitWebBackForwardList
+ * @history_item: the #WebKitWebHistoryItem to check
  *
- * Checks if @webHistoryItem is in the back forward list
+ * Checks if @web_history_item is in the back forward list
  *
- * Return: %TRUE if @webHistoryItem is in the back forward list, %FALSE if it doesn't
+ * Return: %TRUE if @web_history_item is in the back forward list, %FALSE if it doesn't
  */
 gboolean webkit_web_back_forward_list_contains_item(WebKitWebBackForwardList* webBackForwardList, WebKitWebHistoryItem* webHistoryItem)
 {
@@ -129,10 +129,10 @@ gboolean webkit_web_back_forward_list_contains_item(WebKitWebBackForwardList* we
 
 /**
  * webkit_web_back_forward_list_go_to_item:
- * @webBackForwardList: a #WebKitWebBackForwardList
- * @webHistoryItem: the #WebKitWebHistoryItem to go to
+ * @web_back_forward_list: a #WebKitWebBackForwardList
+ * @history_item: the #WebKitWebHistoryItem to go to
  *
- * Go to the specified @webHistoryItem in the back forward list
+ * Go to the specified @web_history_item in the back forward list
  */
 void webkit_web_back_forward_list_go_to_item(WebKitWebBackForwardList* webBackForwardList, WebKitWebHistoryItem* webHistoryItem)
 {
@@ -148,7 +148,7 @@ void webkit_web_back_forward_list_go_to_item(WebKitWebBackForwardList* webBackFo
 
 /**
  * webkit_web_back_forward_list_get_forward_list_with_limit:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  * @limit: the number of items to retrieve
  *
  * Returns a list of items that succeed the current item, limited by @limit
@@ -178,7 +178,7 @@ GList* webkit_web_back_forward_list_get_forward_list_with_limit(WebKitWebBackFor
 
 /**
  * webkit_web_back_forward_list_get_back_list_with_limit:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  * @limit: the number of items to retrieve
  *
  * Returns a list of items that precede the current item, limited by @limit
@@ -207,7 +207,7 @@ GList* webkit_web_back_forward_list_get_back_list_with_limit(WebKitWebBackForwar
 }
 /**
  * webkit_web_back_forward_list_get_back_item:
- * @webBackForwardList: a #WebBackForwardList
+ * @web_back_forward_list: a #WebBackForwardList
  *
  * Returns the item that precedes the current item
  *
@@ -228,7 +228,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_back_item(WebKitWebBackFo
 
 /**
  * webkit_web_back_forward_list_get_current_item:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Returns the current item.
  *
@@ -251,7 +251,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_current_item(WebKitWebBac
 
 /**
  * webkit_web_back_forward_list_get_forward_item:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Returns the item that succeeds the current item.
  *
@@ -274,7 +274,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_forward_item(WebKitWebBac
 
 /**
  * webkit_web_back_forward_list_get_nth_item:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  * @index: the index of the item
  *
  * Returns the item at a given index relative to the current item.
@@ -296,7 +296,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_nth_item(WebKitWebBackFor
 
 /**
  * webkit_web_back_forward_list_get_back_length:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Returns the number of items that preced the current item.
  *
@@ -315,7 +315,7 @@ gint webkit_web_back_forward_list_get_back_length(WebKitWebBackForwardList* webB
 
 /**
  * webkit_web_back_forward_list_get_forward_length:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Returns the number of items that succeed the current item.
  *
@@ -334,7 +334,7 @@ gint webkit_web_back_forward_list_get_forward_length(WebKitWebBackForwardList* w
 
 /**
  * webkit_web_back_forward_list_get_limit:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  *
  * Returns the maximum limit of the back forward list.
  *
@@ -353,7 +353,7 @@ gint webkit_web_back_forward_list_get_limit(WebKitWebBackForwardList* webBackFor
 
 /**
  * webkit_web_back_forward_list_set_limit:
- * @webBackForwardList: a #WebKitWebBackForwardList
+ * @web_back_forward_list: a #WebKitWebBackForwardList
  * @limit: the limit to set the back forward list to
  *
  * Sets the maximum limit of the back forward list. If the back forward list
diff --git a/WebKit/gtk/webkit/webkitwebbackforwardlist.h b/WebKit/gtk/webkit/webkitwebbackforwardlist.h
index 68e18eb..15ce3c3 100644
--- a/WebKit/gtk/webkit/webkitwebbackforwardlist.h
+++ b/WebKit/gtk/webkit/webkitwebbackforwardlist.h
@@ -40,6 +40,7 @@ typedef struct _WebKitWebBackForwardListPrivate WebKitWebBackForwardListPrivate;
 struct _WebKitWebBackForwardList {
     GObject parent_instance;
 
+    /*< private >*/
     WebKitWebBackForwardListPrivate *priv;
 };
 
diff --git a/WebKit/gtk/webkit/webkitwebframe.h b/WebKit/gtk/webkit/webkitwebframe.h
index 827e4b9..fcdace6 100644
--- a/WebKit/gtk/webkit/webkitwebframe.h
+++ b/WebKit/gtk/webkit/webkitwebframe.h
@@ -41,12 +41,14 @@ typedef struct _WebKitWebFramePrivate WebKitWebFramePrivate;
 struct _WebKitWebFrame {
     GObject parent_instance;
 
+    /*< private >*/
     WebKitWebFramePrivate *priv;
 };
 
 struct _WebKitWebFrameClass {
     GObjectClass parent_class;
 
+    /*< public >*/
     void (*_webkit_reserved1) (void);
     void (*_webkit_reserved2) (void);
     void (*_webkit_reserved3) (void);
diff --git a/WebKit/gtk/webkit/webkitwebhistoryitem.cpp b/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
index 150df68..60b1746 100644
--- a/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
+++ b/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
@@ -312,9 +312,9 @@ WebKitWebHistoryItem* webkit_web_history_item_new_with_data(const gchar* uri, co
 
 /**
  * webkit_web_history_item_get_title:
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  *
- * Returns the page title of @webHistoryItem
+ * Returns: the page title of @web_history_item
  */
 G_CONST_RETURN gchar* webkit_web_history_item_get_title(WebKitWebHistoryItem* webHistoryItem)
 {
@@ -332,11 +332,11 @@ G_CONST_RETURN gchar* webkit_web_history_item_get_title(WebKitWebHistoryItem* we
 
 /**
  * webkit_web_history_item_get_alternate_title:
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  *
- * Returns the alternate title of @webHistoryItem
+ * Returns the alternate title of @web_history_item
  *
- * Return value: the alternate title of @webHistoryItem
+ * Return value: the alternate title of @web_history_item
  */
 G_CONST_RETURN gchar* webkit_web_history_item_get_alternate_title(WebKitWebHistoryItem* webHistoryItem)
 {
@@ -354,10 +354,10 @@ G_CONST_RETURN gchar* webkit_web_history_item_get_alternate_title(WebKitWebHisto
 
 /**
  * webkit_web_history_item_set_alternate_title:
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  * @title: the alternate title for @this history item
  *
- * Sets an alternate title for @webHistoryItem
+ * Sets an alternate title for @web_history_item
  */
 void webkit_web_history_item_set_alternate_title(WebKitWebHistoryItem* webHistoryItem, const gchar* title)
 {
@@ -372,11 +372,11 @@ void webkit_web_history_item_set_alternate_title(WebKitWebHistoryItem* webHistor
 
 /**
  * webkit_web_history_item_get_uri:
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  *
  * Returns the URI of @this
  *
- * Return value: the URI of @webHistoryItem
+ * Return value: the URI of @web_history_item
  */
 G_CONST_RETURN gchar* webkit_web_history_item_get_uri(WebKitWebHistoryItem* webHistoryItem)
 {
@@ -394,11 +394,11 @@ G_CONST_RETURN gchar* webkit_web_history_item_get_uri(WebKitWebHistoryItem* webH
 
 /**
  * webkit_web_history_item_get_original_uri:
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  *
- * Returns the original URI of @webHistoryItem.
+ * Returns the original URI of @web_history_item.
  *
- * Return value: the original URI of @webHistoryITem
+ * Return value: the original URI of @web_history_item
  */
 G_CONST_RETURN gchar* webkit_web_history_item_get_original_uri(WebKitWebHistoryItem* webHistoryItem)
 {
@@ -416,11 +416,11 @@ G_CONST_RETURN gchar* webkit_web_history_item_get_original_uri(WebKitWebHistoryI
 
 /**
  * webkit_web_history_item_get_last_visisted_time :
- * @webHistoryItem: a #WebKitWebHistoryItem
+ * @web_history_item: a #WebKitWebHistoryItem
  *
- * Returns the last time @webHistoryItem was visited
+ * Returns the last time @web_history_item was visited
  *
- * Return value: the time in seconds this @webHistoryItem was last visited
+ * Return value: the time in seconds this @web_history_item was last visited
  */
 gdouble webkit_web_history_item_get_last_visited_time(WebKitWebHistoryItem* webHistoryItem)
 {
diff --git a/WebKit/gtk/webkit/webkitwebview.cpp b/WebKit/gtk/webkit/webkitwebview.cpp
index 3cf16c9..9e36991 100644
--- a/WebKit/gtk/webkit/webkitwebview.cpp
+++ b/WebKit/gtk/webkit/webkitwebview.cpp
@@ -1574,7 +1574,7 @@ WebKitWebSettings* webkit_web_view_get_settings(WebKitWebView* webView)
 
 /**
  * webkit_web_view_get_inspector:
- * @webView: a #WebKitWebView
+ * @web_view: a #WebKitWebView
  *
  * Obtains the #WebKitWebInspector associated with the
  * #WebKitWebView. Every #WebKitWebView object has a
@@ -1598,7 +1598,7 @@ WebKitWebInspector* webkit_web_view_get_inspector(WebKitWebView* webView)
 
 /**
  * webkit_web_view_set_maintains_back_forward_list:
- * @webView: a #WebKitWebView
+ * @web_view: a #WebKitWebView
  * @flag: to tell the view to maintain a back or forward list
  *
  * Set the view to maintain a back or forward list of history items.
@@ -1612,7 +1612,7 @@ void webkit_web_view_set_maintains_back_forward_list(WebKitWebView* webView, gbo
 
 /**
  * webkit_web_view_get_back_forward_list:
- * @webView: a #WebKitWebView
+ * @web_view: a #WebKitWebView
  *
  * Returns a #WebKitWebBackForwardList
  *
@@ -1632,7 +1632,7 @@ WebKitWebBackForwardList* webkit_web_view_get_back_forward_list(WebKitWebView* w
 
 /**
  * webkit_web_view_go_to_back_forward_item:
- * @webView: a #WebKitWebView
+ * @web_view: a #WebKitWebView
  * @item: a #WebKitWebHistoryItem*
  *
  * Go to the specified #WebKitWebHistoryItem
diff --git a/WebKit/gtk/webkit/webkitwebview.h b/WebKit/gtk/webkit/webkitwebview.h
index 7371959..c7ad590 100644
--- a/WebKit/gtk/webkit/webkitwebview.h
+++ b/WebKit/gtk/webkit/webkitwebview.h
@@ -55,12 +55,14 @@ typedef enum
 struct _WebKitWebView {
     GtkContainer parent_instance;
 
+    /*< private >*/
     WebKitWebViewPrivate *priv;
 };
 
 struct _WebKitWebViewClass {
     GtkContainerClass parent_class;
 
+    /*< public >*/
     /*
      * default handler/virtual methods
      * DISCUSS: create_web_view needs a request and should we make this a signal with default handler? this would
@@ -172,7 +174,7 @@ webkit_web_view_load_html_string                (WebKitWebView        *web_view,
 
 WEBKIT_API gboolean
 webkit_web_view_search_text                     (WebKitWebView        *web_view,
-                                                 const gchar          *string,
+                                                 const gchar          *text,
                                                  gboolean              case_sensitive,
                                                  gboolean              forward,
                                                  gboolean              wrap);
-- 
1.5.6.3