diff options
| author | Benjamin Otte <otte@redhat.com> | 2012-09-19 15:30:21 +0200 |
|---|---|---|
| committer | Benjamin Otte <otte@redhat.com> | 2012-09-19 15:30:21 +0200 |
| commit | 697ed544ddd15b5811b226e886d87f6dcf69eaf3 (patch) | |
| tree | a232e219412db0ba02c1a1cd3e56be514f48b9bc | |
| parent | ee91f2208627c52b8cee9dbaffe0755cb5fa8df8 (diff) | |
| download | gtk+-697ed544ddd15b5811b226e886d87f6dcf69eaf3.tar.gz | |
docs: Clarify GtkCssProvider loading return values
| -rw-r--r-- | gtk/gtkcssprovider.c | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c index 483ea58c80..cdeb00b1d1 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, |