2010-08-17 Gustavo Noronha Silva <gustavo.noronha@collabora.couk>
authorkov@webkit.org <kov@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 17 Aug 2010 20:00:35 +0000 (20:00 +0000)
committerkov@webkit.org <kov@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 17 Aug 2010 20:00:35 +0000 (20:00 +0000)
        Reviewed by Martin Robinson.

        WebBackForwardList.get_{back|forward}_list_with_limit not introspectable
        https://bugs.webkit.org/show_bug.cgi?id=43054

        * GNUmakefile.am: Give also API implementation files to the GIR
        scanner.

WebKit/gtk

2010-08-17  Gustavo Noronha Silva  <gustavo.noronha@collabora.co.uk>

        Reviewed by Martin Robinson.

        WebBackForwardList.get_{back|forward}_list_with_limit not introspectable
        https://bugs.webkit.org/show_bug.cgi?id=43054

        Annotate WebKitWebBackForwardList and the function that is used to fetch it from
        the WebKitWebView. More will follow.

        * webkit/webkitwebbackforwardlist.cpp: Annotations, and small
        improvements to the docs.
        * webkit/webkitwebbackforwardlist.h: Couple empty lines missing.
        * webkit/webkitwebview.cpp:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@65532 268f45cc-cd09-0410-ab3c-d52691b4dbfc

ChangeLog
GNUmakefile.am
WebKit/gtk/ChangeLog
WebKit/gtk/webkit/webkitwebbackforwardlist.cpp
WebKit/gtk/webkit/webkitwebbackforwardlist.h
WebKit/gtk/webkit/webkitwebview.cpp

index 0bd2662..92f4c9b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2010-08-17  Gustavo Noronha Silva  <gustavo.noronha@collabora.couk>
+
+        Reviewed by Martin Robinson.
+
+        WebBackForwardList.get_{back|forward}_list_with_limit not introspectable
+        https://bugs.webkit.org/show_bug.cgi?id=43054
+
+        * GNUmakefile.am: Give also API implementation files to the GIR
+        scanner.
+
 2010-08-17  Martin Robinson  <mrobinson@igalia.com>
 
         GTK+ Build fix for those having stable versions of GLib.
 2010-08-17  Martin Robinson  <mrobinson@igalia.com>
 
         GTK+ Build fix for those having stable versions of GLib.
index 91653cf..e45dfed 100644 (file)
@@ -846,7 +846,8 @@ $(WEBKIT_GIRSOURCES): $(G_IR_SCANNER) $(JSCORE_GIRSOURCES) libwebkitgtk-@WEBKITG
             -I$(top_builddir)/DerivedSources/webkit \
             -I$(top_srcdir)/JavaScriptCore/ForwardingHeaders \
             -I$(top_srcdir) \
             -I$(top_builddir)/DerivedSources/webkit \
             -I$(top_srcdir)/JavaScriptCore/ForwardingHeaders \
             -I$(top_srcdir) \
-            $(webkitgtk_h_api)
+            $(webkitgtk_h_api) \
+            $(top_srcdir)/WebKit/gtk/webkit/*.cpp
 
 girdir = $(datadir)/gir-1.0
 gir_DATA = $(WEBKIT_GIRSOURCES) $(JSCORE_GIRSOURCES)
 
 girdir = $(datadir)/gir-1.0
 gir_DATA = $(WEBKIT_GIRSOURCES) $(JSCORE_GIRSOURCES)
index 316d95f..4759d46 100644 (file)
@@ -1,3 +1,18 @@
+2010-08-17  Gustavo Noronha Silva  <gustavo.noronha@collabora.co.uk>
+
+        Reviewed by Martin Robinson.
+
+        WebBackForwardList.get_{back|forward}_list_with_limit not introspectable
+        https://bugs.webkit.org/show_bug.cgi?id=43054
+
+        Annotate WebKitWebBackForwardList and the function that is used to fetch it from
+        the WebKitWebView. More will follow.
+
+        * webkit/webkitwebbackforwardlist.cpp: Annotations, and small
+        improvements to the docs.
+        * webkit/webkitwebbackforwardlist.h: Couple empty lines missing.
+        * webkit/webkitwebview.cpp:
+
 2010-08-17  Martin Robinson  <mrobinson@igalia.com>
 
         Reviewed by Gustavo Noronha Silva.
 2010-08-17  Martin Robinson  <mrobinson@igalia.com>
 
         Reviewed by Gustavo Noronha Silva.
index 70fdea5..e1bdac4 100644 (file)
@@ -96,7 +96,7 @@ static void webkit_web_back_forward_list_init(WebKitWebBackForwardList* webBackF
 }
 
 /**
 }
 
 /**
- * webkit_web_back_forward_list_new_with_web_view:
+ * webkit_web_back_forward_list_new_with_web_view: (skip)
  * @web_view: the back forward list's #WebKitWebView
  *
  * Creates an instance of the back forward list with a controlling #WebKitWebView
  * @web_view: the back forward list's #WebKitWebView
  *
  * Creates an instance of the back forward list with a controlling #WebKitWebView
@@ -151,11 +151,11 @@ void webkit_web_back_forward_list_go_back(WebKitWebBackForwardList* webBackForwa
 /**
  * webkit_web_back_forward_list_contains_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
 /**
  * webkit_web_back_forward_list_contains_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
- * @history_item: the #WebKitWebHistoryItem to check
+ * @history_item: (type WebKit.WebHistoryItem) (transfer none): the #WebKitWebHistoryItem to check
  *
  * Checks if @web_history_item is in the back forward list
  *
  *
  * Checks if @web_history_item is in the back forward list
  *
- * Return: %TRUE if @web_history_item is in the back forward list, %FALSE if it doesn't
+ * Return value: %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)
 {
  */
 gboolean webkit_web_back_forward_list_contains_item(WebKitWebBackForwardList* webBackForwardList, WebKitWebHistoryItem* webHistoryItem)
 {
@@ -174,7 +174,7 @@ gboolean webkit_web_back_forward_list_contains_item(WebKitWebBackForwardList* we
 /**
  * webkit_web_back_forward_list_go_to_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
 /**
  * webkit_web_back_forward_list_go_to_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
- * @history_item: the #WebKitWebHistoryItem to go to
+ * @history_item: (type WebKit.WebHistoryItem) (transfer none): the #WebKitWebHistoryItem to go to
  *
  * Go to the specified @web_history_item in the back forward list
  */
  *
  * Go to the specified @web_history_item in the back forward list
  */
@@ -197,7 +197,7 @@ void webkit_web_back_forward_list_go_to_item(WebKitWebBackForwardList* webBackFo
  *
  * Returns a list of items that succeed the current item, limited by @limit
  *
  *
  * Returns a list of items that succeed the current item, limited by @limit
  *
- * Return value: a #GList of items succeeding the current item, limited by @limit
+ * Return value: (element-type WebKit.WebHistoryItem) (transfer container): a #GList of items succeeding the current item, limited by @limit
  */
 GList* webkit_web_back_forward_list_get_forward_list_with_limit(WebKitWebBackForwardList* webBackForwardList, gint limit)
 {
  */
 GList* webkit_web_back_forward_list_get_forward_list_with_limit(WebKitWebBackForwardList* webBackForwardList, gint limit)
 {
@@ -227,7 +227,7 @@ GList* webkit_web_back_forward_list_get_forward_list_with_limit(WebKitWebBackFor
  *
  * Returns a list of items that precede the current item, limited by @limit
  *
  *
  * Returns a list of items that precede the current item, limited by @limit
  *
- * Return value: a #GList of items preceding the current item, limited by @limit
+ * Return value: (element-type WebKit.WebHistoryItem) (transfer container): a #GList of items preceding the current item, limited by @limit
  */
 GList* webkit_web_back_forward_list_get_back_list_with_limit(WebKitWebBackForwardList* webBackForwardList, gint limit)
 {
  */
 GList* webkit_web_back_forward_list_get_back_list_with_limit(WebKitWebBackForwardList* webBackForwardList, gint limit)
 {
@@ -256,7 +256,7 @@ GList* webkit_web_back_forward_list_get_back_list_with_limit(WebKitWebBackForwar
  *
  * Returns the item that precedes the current item
  *
  *
  * Returns the item that precedes the current item
  *
- * Return value: the #WebKitWebHistoryItem preceding the current item
+ * Return value: (type WebKit.WebHistoryItem) (transfer none): the #WebKitWebHistoryItem preceding the current item
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_back_item(WebKitWebBackForwardList* webBackForwardList)
 {
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_back_item(WebKitWebBackForwardList* webBackForwardList)
 {
@@ -279,7 +279,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_back_item(WebKitWebBackFo
  *
  * Returns a NULL value if the back forward list is empty
  *
  *
  * Returns a NULL value if the back forward list is empty
  *
- * Return value: a #WebKitWebHistoryItem
+ * Return value: (type WebKit.WebHistoryItem) (transfer none): a #WebKitWebHistoryItem
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_current_item(WebKitWebBackForwardList* webBackForwardList)
 {
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_current_item(WebKitWebBackForwardList* webBackForwardList)
 {
@@ -302,7 +302,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_current_item(WebKitWebBac
  *
  * Returns a NULL value if there nothing that succeeds the current item
  *
  *
  * Returns a NULL value if there nothing that succeeds the current item
  *
- * Return value: a #WebKitWebHistoryItem
+ * Return value: (type WebKit.WebHistoryItem) (transfer none): a #WebKitWebHistoryItem
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_forward_item(WebKitWebBackForwardList* webBackForwardList)
 {
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_forward_item(WebKitWebBackForwardList* webBackForwardList)
 {
@@ -324,7 +324,7 @@ WebKitWebHistoryItem* webkit_web_back_forward_list_get_forward_item(WebKitWebBac
  *
  * Returns the item at a given index relative to the current item.
  *
  *
  * Returns the item at a given index relative to the current item.
  *
- * Return value: the #WebKitWebHistoryItem located at the specified index relative to the current item
+ * Return value: (type WebKit.WebHistoryItem) (transfer none): the #WebKitWebHistoryItem located at the specified index relative to the current item
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_nth_item(WebKitWebBackForwardList* webBackForwardList, gint index)
 {
  */
 WebKitWebHistoryItem* webkit_web_back_forward_list_get_nth_item(WebKitWebBackForwardList* webBackForwardList, gint index)
 {
@@ -417,7 +417,7 @@ void webkit_web_back_forward_list_set_limit(WebKitWebBackForwardList* webBackFor
 /**
  * webkit_web_back_forward_list_add_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
 /**
  * webkit_web_back_forward_list_add_item:
  * @web_back_forward_list: a #WebKitWebBackForwardList
- * @history_item: the #WebKitWebHistoryItem to add
+ * @history_item: (type WebKit.WebHistoryItem) (transfer none): the #WebKitWebHistoryItem to add
  *
  * Adds the item to the #WebKitWebBackForwardList.
  *
  *
  * Adds the item to the #WebKitWebBackForwardList.
  *
@@ -440,7 +440,7 @@ void webkit_web_back_forward_list_add_item(WebKitWebBackForwardList *webBackForw
 
 /**
  * webkit_web_back_forward_list_clear:
 
 /**
  * webkit_web_back_forward_list_clear:
- * @webBackForwardList:  a #WebKitWebBackForwardList
+ * @web_back_forward_list: the #WebKitWebBackForwardList to be cleared
  *
  * Clears the @webBackForwardList by removing all its elements. Note that not even
  * the current page is kept in list when cleared so you would have to add it later.
  *
  * Clears the @webBackForwardList by removing all its elements. Note that not even
  * the current page is kept in list when cleared so you would have to add it later.
index 2cffc68..15ddc94 100644 (file)
@@ -107,9 +107,11 @@ webkit_web_back_forward_list_get_limit                   (WebKitWebBackForwardLi
 WEBKIT_API void
 webkit_web_back_forward_list_set_limit                   (WebKitWebBackForwardList *web_back_forward_list,
                                                           gint                      limit);
 WEBKIT_API void
 webkit_web_back_forward_list_set_limit                   (WebKitWebBackForwardList *web_back_forward_list,
                                                           gint                      limit);
+
 WEBKIT_API void
 webkit_web_back_forward_list_add_item                    (WebKitWebBackForwardList *web_back_forward_list,
                                                           WebKitWebHistoryItem     *history_item);
 WEBKIT_API void
 webkit_web_back_forward_list_add_item                    (WebKitWebBackForwardList *web_back_forward_list,
                                                           WebKitWebHistoryItem     *history_item);
+
 WEBKIT_API void
 webkit_web_back_forward_list_clear                       (WebKitWebBackForwardList *web_back_forward_list);
 
 WEBKIT_API void
 webkit_web_back_forward_list_clear                       (WebKitWebBackForwardList *web_back_forward_list);
 
index 6de33fd..64b7dcc 100644 (file)
@@ -3302,9 +3302,10 @@ void webkit_web_view_set_maintains_back_forward_list(WebKitWebView* webView, gbo
  * webkit_web_view_get_back_forward_list:
  * @web_view: a #WebKitWebView
  *
  * webkit_web_view_get_back_forward_list:
  * @web_view: a #WebKitWebView
  *
- * Returns a #WebKitWebBackForwardList
+ * Obtains the #WebKitBackForwardList associated with the given #WebKitWebView. The
+ * #WebKitWebBackForwardList is owned by the #WebKitWebView.
  *
  *
- * Return value: the #WebKitWebBackForwardList
+ * Return value: (transfer none): the #WebKitWebBackForwardList
  */
 WebKitWebBackForwardList* webkit_web_view_get_back_forward_list(WebKitWebView* webView)
 {
  */
 WebKitWebBackForwardList* webkit_web_view_get_back_forward_list(WebKitWebView* webView)
 {