[gtk+] docs: Clarify GtkCssProvider loading return values
- From: Benjamin Otte <otte src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: Clarify GtkCssProvider loading return values
- Date: Wed, 19 Sep 2012 13:34:45 +0000 (UTC)
commit 697ed544ddd15b5811b226e886d87f6dcf69eaf3
Author: Benjamin Otte <otte redhat com>
Date: Wed Sep 19 15:30:21 2012 +0200
docs: Clarify GtkCssProvider loading return values
gtk/gtkcssprovider.c | 15 ++++++++++++---
1 files changed, 12 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c
index 483ea58..cdeb00b 100644
--- a/gtk/gtkcssprovider.c
+++ b/gtk/gtkcssprovider.c
@@ -2567,7 +2567,10 @@ gtk_css_provider_load_internal (GtkCssProvider *css_provider,
* Loads @data into @css_provider, making it clear any previously loaded
* information.
*
- * Returns: %TRUE if the data could be loaded.
+ * Returns: %TRUE. The return value is deprecated and %FALSE will only be
+ * returned for backwards compatibility reasons if an @error is not
+ * %NULL and a loading error occured. To track errors while loading
+ * CSS, connect to the GtkCssProvider::parsing-error signal.
**/
gboolean
gtk_css_provider_load_from_data (GtkCssProvider *css_provider,
@@ -2612,7 +2615,10 @@ gtk_css_provider_load_from_data (GtkCssProvider *css_provider,
* Loads the data contained in @file into @css_provider, making it
* clear any previously loaded information.
*
- * Returns: %TRUE if the data could be loaded.
+ * Returns: %TRUE. The return value is deprecated and %FALSE will only be
+ * returned for backwards compatibility reasons if an @error is not
+ * %NULL and a loading error occured. To track errors while loading
+ * CSS, connect to the GtkCssProvider::parsing-error signal.
**/
gboolean
gtk_css_provider_load_from_file (GtkCssProvider *css_provider,
@@ -2642,7 +2648,10 @@ gtk_css_provider_load_from_file (GtkCssProvider *css_provider,
* Loads the data contained in @path into @css_provider, making it clear
* any previously loaded information.
*
- * Returns: %TRUE if the data could be loaded.
+ * Returns: %TRUE. The return value is deprecated and %FALSE will only be
+ * returned for backwards compatibility reasons if an @error is not
+ * %NULL and a loading error occured. To track errors while loading
+ * CSS, connect to the GtkCssProvider::parsing-error signal.
**/
gboolean
gtk_css_provider_load_from_path (GtkCssProvider *css_provider,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]