[SCM] WebKit Debian packaging branch, debian/experimental, updated. upstream/1.3.3-9427-gc2be6fc
xan at webkit.org
xan at webkit.org
Wed Dec 22 13:39:00 UTC 2010
The following commit has been merged in the debian/experimental branch:
commit c18b5c7f90056566b07b02fc9db7ef29048cd94f
Author: xan at webkit.org <xan at webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Wed Sep 22 14:40:34 2010 +0000
2010-09-21 Xan Lopez <xlopez at igalia.com>
Reviewed by Martin Robinson.
[GTK] Fix transfer annotations for WebKitGTK+ static API
https://bugs.webkit.org/show_bug.cgi?id=46244
Deal with all the warnings related to transfer issues. Mostly the
problem was the transfer being missing, but there were also typos
in the function name or missing ':' at the end of the function
name in the gtk-doc.
* webkit/webkitdownload.cpp:
* webkit/webkitnetworkrequest.cpp:
* webkit/webkitnetworkresponse.cpp:
* webkit/webkitsecurityorigin.cpp:
* webkit/webkitwebdatabase.cpp:
* webkit/webkitwebdatasource.cpp:
* webkit/webkitwebframe.cpp:
* webkit/webkitwebhistoryitem.cpp:
* webkit/webkitwebinspector.cpp:
* webkit/webkitwebresource.cpp:
* webkit/webkitwebsettings.cpp:
* webkit/webkitwebview.cpp:
(webkit_web_view_class_init):
(webkit_web_view_get_main_frame):
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@68040 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/gtk/ChangeLog b/WebKit/gtk/ChangeLog
index 56eb6ae..6680cf4 100644
--- a/WebKit/gtk/ChangeLog
+++ b/WebKit/gtk/ChangeLog
@@ -1,5 +1,32 @@
2010-09-21 Xan Lopez <xlopez at igalia.com>
+ Reviewed by Martin Robinson.
+
+ [GTK] Fix transfer annotations for WebKitGTK+ static API
+ https://bugs.webkit.org/show_bug.cgi?id=46244
+
+ Deal with all the warnings related to transfer issues. Mostly the
+ problem was the transfer being missing, but there were also typos
+ in the function name or missing ':' at the end of the function
+ name in the gtk-doc.
+
+ * webkit/webkitdownload.cpp:
+ * webkit/webkitnetworkrequest.cpp:
+ * webkit/webkitnetworkresponse.cpp:
+ * webkit/webkitsecurityorigin.cpp:
+ * webkit/webkitwebdatabase.cpp:
+ * webkit/webkitwebdatasource.cpp:
+ * webkit/webkitwebframe.cpp:
+ * webkit/webkitwebhistoryitem.cpp:
+ * webkit/webkitwebinspector.cpp:
+ * webkit/webkitwebresource.cpp:
+ * webkit/webkitwebsettings.cpp:
+ * webkit/webkitwebview.cpp:
+ (webkit_web_view_class_init):
+ (webkit_web_view_get_main_frame):
+
+2010-09-21 Xan Lopez <xlopez at igalia.com>
+
Reviewed by Gustavo Noronha.
Update for 1.3.4 release.
diff --git a/WebKit/gtk/webkit/webkitdownload.cpp b/WebKit/gtk/webkit/webkitdownload.cpp
index 1e45250..1472cb5 100644
--- a/WebKit/gtk/webkit/webkitdownload.cpp
+++ b/WebKit/gtk/webkit/webkitdownload.cpp
@@ -559,7 +559,7 @@ const gchar* webkit_download_get_uri(WebKitDownload* download)
* Retrieves the #WebKitNetworkRequest object that backs the download
* process.
*
- * Returns: the #WebKitNetworkRequest instance
+ * Returns: (transfer none): the #WebKitNetworkRequest instance
*
* Since: 1.1.2
*/
@@ -578,7 +578,7 @@ WebKitNetworkRequest* webkit_download_get_network_request(WebKitDownload* downlo
* Retrieves the #WebKitNetworkResponse object that backs the download
* process.
*
- * Returns: the #WebKitNetworkResponse instance
+ * Returns: (transfer none): the #WebKitNetworkResponse instance
*
* Since: 1.1.16
*/
diff --git a/WebKit/gtk/webkit/webkitnetworkrequest.cpp b/WebKit/gtk/webkit/webkitnetworkrequest.cpp
index 8b50948..6180efa 100644
--- a/WebKit/gtk/webkit/webkitnetworkrequest.cpp
+++ b/WebKit/gtk/webkit/webkitnetworkrequest.cpp
@@ -241,7 +241,7 @@ G_CONST_RETURN gchar* webkit_network_request_get_uri(WebKitNetworkRequest* reque
}
/**
- * webkit_network_request_get_soup_message:
+ * webkit_network_request_get_message:
* @request: a #WebKitNetworkRequest
*
* Obtains the #SoupMessage held and used by the given request. Notice
@@ -249,7 +249,7 @@ G_CONST_RETURN gchar* webkit_network_request_get_uri(WebKitNetworkRequest* reque
* handlers is only supported (as in, will only affect what is
* actually sent to the server) where explicitly documented.
*
- * Returns: the #SoupMessage
+ * Returns: (transfer none): the #SoupMessage
* Since: 1.1.9
*/
SoupMessage* webkit_network_request_get_message(WebKitNetworkRequest* request)
diff --git a/WebKit/gtk/webkit/webkitnetworkresponse.cpp b/WebKit/gtk/webkit/webkitnetworkresponse.cpp
index d4dd562..0aca6d8 100644
--- a/WebKit/gtk/webkit/webkitnetworkresponse.cpp
+++ b/WebKit/gtk/webkit/webkitnetworkresponse.cpp
@@ -241,14 +241,14 @@ G_CONST_RETURN gchar* webkit_network_response_get_uri(WebKitNetworkResponse* res
}
/**
- * webkit_network_response_get_soup_message:
+ * webkit_network_response_get_message:
* @response: a #WebKitNetworkResponse
*
* Obtains the #SoupMessage that represents the given response. Notice
* that only the response side of the HTTP conversation is
* represented.
*
- * Returns: the #SoupMessage
+ * Returns: (transfer none): the #SoupMessage
* Since: 1.1.14
*/
SoupMessage* webkit_network_response_get_message(WebKitNetworkResponse* response)
diff --git a/WebKit/gtk/webkit/webkitsecurityorigin.cpp b/WebKit/gtk/webkit/webkitsecurityorigin.cpp
index de074ae..67ad0cf 100644
--- a/WebKit/gtk/webkit/webkitsecurityorigin.cpp
+++ b/WebKit/gtk/webkit/webkitsecurityorigin.cpp
@@ -353,7 +353,8 @@ void webkit_security_origin_set_web_database_quota(WebKitSecurityOrigin* securit
*
* Returns a list of all Web Databases in the security origin.
*
- * Returns: a #GList of databases in the security origin.
+ * Returns: (transfer container) (element-type WebKitWebDatabase): a
+ * #GList of databases in the security origin.
*
* Since: 1.1.14
**/
diff --git a/WebKit/gtk/webkit/webkitwebdatabase.cpp b/WebKit/gtk/webkit/webkitwebdatabase.cpp
index d4f6198..cd85e73 100644
--- a/WebKit/gtk/webkit/webkitwebdatabase.cpp
+++ b/WebKit/gtk/webkit/webkitwebdatabase.cpp
@@ -284,7 +284,7 @@ static void webkit_web_database_set_name(WebKitWebDatabase* webDatabase, const g
*
* Returns the security origin of the #WebKitWebDatabase.
*
- * Returns: the security origin of the database
+ * Returns: (transfer none): the security origin of the database
*
* Since: 1.1.14
**/
diff --git a/WebKit/gtk/webkit/webkitwebdatasource.cpp b/WebKit/gtk/webkit/webkitwebdatasource.cpp
index 9b755ad..38c9c48 100644
--- a/WebKit/gtk/webkit/webkitwebdatasource.cpp
+++ b/WebKit/gtk/webkit/webkitwebdatasource.cpp
@@ -194,14 +194,15 @@ WebKitWebDataSource* webkit_web_data_source_new_with_request(WebKitNetworkReques
}
/**
- * webkit_web_data_source_get_web_frame
+ * webkit_web_data_source_get_web_frame:
* @data_source: a #WebKitWebDataSource
*
* Returns the #WebKitWebFrame that represents this data source
*
- * Return value: the #WebKitWebFrame that represents the @data_source. The
- * #WebKitWebFrame is owned by WebKit and should not be freed or destroyed.
- * This will return %NULL of the @data_source is not attached to a frame.
+ * Return value: (transfer none): the #WebKitWebFrame that represents
+ * the @data_source. The #WebKitWebFrame is owned by WebKit and should
+ * not be freed or destroyed. This will return %NULL if the
+ * @data_source is not attached to a frame.
*
* Since: 1.1.14
*/
@@ -227,7 +228,7 @@ WebKitWebFrame* webkit_web_data_source_get_web_frame(WebKitWebDataSource* webDat
* prior to the "committed" load state. See webkit_web_data_source_get_request
* for getting the "committed" request.
*
- * Return value: the original #WebKitNetworkRequest
+ * Return value: (transfer none): the original #WebKitNetworkRequest
*
* Since: 1.1.14
*/
@@ -254,9 +255,9 @@ WebKitNetworkRequest* webkit_web_data_source_get_initial_request(WebKitWebDataSo
* the request that was "committed", and hence, different from the request you
* get from the webkit_web_data_source_get_initial_request method.
*
- * Return value: the #WebKitNetworkRequest that created the @data_source or
- * %NULL if the @data_source is not attached to the frame or the frame hasn't
- * been loaded.
+ * Return value: (transfer none): the #WebKitNetworkRequest that
+ * created the @data_source or %NULL if the @data_source is not
+ * attached to the frame or the frame hasn't been loaded.
*
* Since: 1.1.14
*/
@@ -333,8 +334,9 @@ gboolean webkit_web_data_source_is_loading(WebKitWebDataSource* webDataSource)
* frame hasn't loaded any data. Use webkit_web_data_source_is_loading to test
* if data source is in the process of loading.
*
- * Return value: a #GString which contains the raw data that represents the @data_source or %NULL if the
- * @data_source hasn't loaded any data.
+ * Return value: (transfer none): a #GString which contains the raw
+ * data that represents the @data_source or %NULL if the @data_source
+ * hasn't loaded any data.
*
* Since: 1.1.14
*/
@@ -364,8 +366,8 @@ GString* webkit_web_data_source_get_data(WebKitWebDataSource* webDataSource)
*
* Returns the main resource of the @data_source
*
- * Return value: a new #WebKitWebResource representing the main resource of
- * the @data_source.
+ * Return value: (transfer none): a new #WebKitWebResource
+ * representing the main resource of the @data_source.
*
* Since: 1.1.14
*/
@@ -414,14 +416,15 @@ G_CONST_RETURN gchar* webkit_web_data_source_get_unreachable_uri(WebKitWebDataSo
}
/**
- * webkit_web_data_source_get_subresources
+ * webkit_web_data_source_get_subresources:
* @data_source: a #WebKitWebDataSource
*
* Gives you a #GList of #WebKitWebResource objects that compose the
* #WebKitWebView to which this #WebKitWebDataSource is attached.
*
- * Return value: a #GList of #WebKitWebResource objects; the objects are
- * owned by WebKit, but the GList must be freed.
+ * Return value: (element-type WebKitWebResource) (transfer container):
+ * a #GList of #WebKitWebResource objects; the objects are owned by
+ * WebKit, but the GList must be freed.
*
* Since: 1.1.15
*/
diff --git a/WebKit/gtk/webkit/webkitwebframe.cpp b/WebKit/gtk/webkit/webkitwebframe.cpp
index 88f0bb7..c581ce6 100644
--- a/WebKit/gtk/webkit/webkitwebframe.cpp
+++ b/WebKit/gtk/webkit/webkitwebframe.cpp
@@ -449,7 +449,7 @@ G_CONST_RETURN gchar* webkit_web_frame_get_uri(WebKitWebFrame* frame)
* The #WebKitWebView returned manages the entire hierarchy of #WebKitWebFrame
* objects that contains @frame.
*
- * Return value: the #WebKitWebView that manages @frame
+ * Return value: (transfer none): the #WebKitWebView that manages @frame
*/
WebKitWebView* webkit_web_frame_get_web_view(WebKitWebFrame* frame)
{
@@ -491,7 +491,7 @@ G_CONST_RETURN gchar* webkit_web_frame_get_name(WebKitWebFrame* frame)
*
* Returns the @frame's parent frame, or %NULL if it has none.
*
- * Return value: the parent #WebKitWebFrame or %NULL in case there is none
+ * Return value: (transfer none): the parent #WebKitWebFrame or %NULL in case there is none
*/
WebKitWebFrame* webkit_web_frame_get_parent(WebKitWebFrame* frame)
{
@@ -662,7 +662,7 @@ void webkit_web_frame_reload(WebKitWebFrame* frame)
* hierarchy, this function will search for a matching frame in other main
* frame hierarchies. Returns %NULL if no match is found.
*
- * Return value: the found #WebKitWebFrame or %NULL in case none is found
+ * Return value: (transfer none): the found #WebKitWebFrame or %NULL in case none is found
*/
WebKitWebFrame* webkit_web_frame_find_frame(WebKitWebFrame* frame, const gchar* name)
{
@@ -684,7 +684,7 @@ WebKitWebFrame* webkit_web_frame_find_frame(WebKitWebFrame* frame, const gchar*
* Gets the global JavaScript execution context. Use this function to bridge
* between the WebKit and JavaScriptCore APIs.
*
- * Return value: the global JavaScript context
+ * Return value: (transfer none): the global JavaScript context
*/
JSGlobalContextRef webkit_web_frame_get_global_context(WebKitWebFrame* frame)
{
@@ -703,7 +703,7 @@ JSGlobalContextRef webkit_web_frame_get_global_context(WebKitWebFrame* frame)
*
* Returns the committed data source.
*
- * Return value: the committed #WebKitWebDataSource.
+ * Return value: (transfer none): the committed #WebKitWebDataSource.
*
* Since: 1.1.14
*/
@@ -724,7 +724,7 @@ WebKitWebDataSource* webkit_web_frame_get_data_source(WebKitWebFrame* frame)
* transition to a committed data source once any data has been received. Use
* webkit_web_frame_get_data_source to get the committed data source.
*
- * Return value: the provisional #WebKitWebDataSource or %NULL if a load
+ * Return value: (transfer none): the provisional #WebKitWebDataSource or %NULL if a load
* request is not in progress.
*
* Since: 1.1.14
@@ -1199,7 +1199,7 @@ GtkPolicyType webkit_web_frame_get_vertical_scrollbar_policy(WebKitWebFrame* fra
*
* Returns the @frame's security origin.
*
- * Return value: the security origin of @frame
+ * Return value: (transfer none): the security origin of @frame
*
* Since: 1.1.14
*/
@@ -1241,7 +1241,7 @@ void webkit_web_frame_layout(WebKitWebFrame* frame)
* frame was not created by a load. You must unref the object when you
* are done with it.
*
- * Return value: a #WebKitNetworkResponse object
+ * Return value: (transfer full): a #WebKitNetworkResponse object
*
* Since: 1.1.18
*/
diff --git a/WebKit/gtk/webkit/webkitwebhistoryitem.cpp b/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
index 8a9153c..ce30704 100644
--- a/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
+++ b/WebKit/gtk/webkit/webkitwebhistoryitem.cpp
@@ -433,14 +433,14 @@ gdouble webkit_web_history_item_get_last_visited_time(WebKitWebHistoryItem* webH
}
/**
- * webkit_web_history_item_copy :
+ * webkit_web_history_item_copy:
* @web_history_item: a #WebKitWebHistoryItem
*
* Makes a copy of the item for use with other WebView objects.
*
* Since: 1.1.18
*
- * Return value: the new #WebKitWebHistoryItem.
+ * Return value: (transfer full): the new #WebKitWebHistoryItem.
*/
WebKitWebHistoryItem* webkit_web_history_item_copy(WebKitWebHistoryItem* self)
{
diff --git a/WebKit/gtk/webkit/webkitwebinspector.cpp b/WebKit/gtk/webkit/webkitwebinspector.cpp
index 2dc9315..ee3c8cd 100644
--- a/WebKit/gtk/webkit/webkitwebinspector.cpp
+++ b/WebKit/gtk/webkit/webkitwebinspector.cpp
@@ -426,8 +426,8 @@ void webkit_web_inspector_set_web_view(WebKitWebInspector *web_inspector, WebKit
* that this method may return %NULL if the user hasn't inspected
* anything.
*
- * Returns: the #WebKitWebView instance that is used to render the
- * inspector or %NULL if it is not yet created.
+ * Returns: (transfer none): the #WebKitWebView instance that is used
+ * to render the inspector or %NULL if it is not yet created.
*
* Since: 1.0.3
**/
diff --git a/WebKit/gtk/webkit/webkitwebresource.cpp b/WebKit/gtk/webkit/webkitwebresource.cpp
index ba9c3af..fb0acfc 100644
--- a/WebKit/gtk/webkit/webkitwebresource.cpp
+++ b/WebKit/gtk/webkit/webkitwebresource.cpp
@@ -285,8 +285,9 @@ WebKitWebResource* webkit_web_resource_new(const gchar* data,
*
* Returns the data of the @webResource.
*
- * Return value: a #GString containing the character data of the @webResource.
- * The string is owned by WebKit and should not be freed or destroyed.
+ * Return value: (transfer none): a #GString containing the character
+ * data of the @webResource. The string is owned by WebKit and should
+ * not be freed or destroyed.
*
* Since: 1.1.14
*/
diff --git a/WebKit/gtk/webkit/webkitwebsettings.cpp b/WebKit/gtk/webkit/webkitwebsettings.cpp
index 767fce1..078bcc3 100644
--- a/WebKit/gtk/webkit/webkitwebsettings.cpp
+++ b/WebKit/gtk/webkit/webkitwebsettings.cpp
@@ -1248,7 +1248,7 @@ WebKitWebSettings* webkit_web_settings_new()
*
* Copies an existing #WebKitWebSettings instance.
*
- * Returns: a new #WebKitWebSettings instance
+ * Returns: (transfer full): a new #WebKitWebSettings instance
**/
WebKitWebSettings* webkit_web_settings_copy(WebKitWebSettings* web_settings)
{
diff --git a/WebKit/gtk/webkit/webkitwebview.cpp b/WebKit/gtk/webkit/webkitwebview.cpp
index 3212450..15ef2e8 100644
--- a/WebKit/gtk/webkit/webkitwebview.cpp
+++ b/WebKit/gtk/webkit/webkitwebview.cpp
@@ -1503,7 +1503,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
* the new #WebKitWebView. The widget to which the widget is added will
* handle that.
*
- * Return value: a newly allocated #WebKitWebView, or %NULL
+ * Return value: (transfer full): a newly allocated #WebKitWebView, or %NULL
*
* Since: 1.0.3
*/
@@ -2264,7 +2264,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
* to set the property value of "webkit-widget-is-selected". This can
* be used to draw a visual indicator of the selection.
*
- * Return value: a new #GtkWidget, or %NULL
+ * Return value: (transfer full): a new #GtkWidget, or %NULL
*
* Since: 1.1.8
*/
@@ -3217,7 +3217,7 @@ static void webkit_web_view_set_window_features(WebKitWebView* webView, WebKitWe
}
/**
- * webkit_web_view_get_window_features
+ * webkit_web_view_get_window_features:
* @web_view: a #WebKitWebView
*
* Returns the instance of #WebKitWebWindowFeatures held by the given
@@ -3642,12 +3642,19 @@ void webkit_web_view_unmark_text_matches(WebKitWebView* webView)
return core(webView)->unmarkAllTextMatches();
}
+/**
+ * webkit_web_view_get_main_frame:
+ * @webView: a #WebKitWebView
+ *
+ * Returns the main frame for the @webView.
+ *
+ * Return value: (transfer none): the main #WebKitWebFrame for @webView
+ */
WebKitWebFrame* webkit_web_view_get_main_frame(WebKitWebView* webView)
{
g_return_val_if_fail(WEBKIT_IS_WEB_VIEW(webView), NULL);
- WebKitWebViewPrivate* priv = webView->priv;
- return priv->mainFrame;
+ return webView->priv->mainFrame;
}
/**
@@ -3656,7 +3663,7 @@ WebKitWebFrame* webkit_web_view_get_main_frame(WebKitWebView* webView)
*
* Returns the frame that has focus or an active text selection.
*
- * Return value: The focused #WebKitWebFrame or %NULL if no frame is focused
+ * Return value: (transfer none): The focused #WebKitWebFrame or %NULL if no frame is focused
*/
WebKitWebFrame* webkit_web_view_get_focused_frame(WebKitWebView* webView)
{
@@ -4532,7 +4539,7 @@ void webkit_web_view_set_tooltip_text(WebKitWebView* webView, const char* toolti
* Does a 'hit test' in the coordinates specified by @event to figure
* out context information about that position in the @webView.
*
- * Returns: a newly created #WebKitHitTestResult with the context of the
+ * Returns: (transfer none): a newly created #WebKitHitTestResult with the context of the
* specified position.
*
* Since: 1.1.15
@@ -4574,7 +4581,7 @@ G_CONST_RETURN gchar* webkit_web_view_get_icon_uri(WebKitWebView* webView)
* webkit_web_view_get_dom_document:
* @webView: a #WebKitWebView
*
- * Returns: the #WebKitDOMDocument currently loaded in the @webView
+ * Returns: (transfer none): the #WebKitDOMDocument currently loaded in the @webView
*
* Since: 1.3.1
**/
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list