Add notes to GtkBuilder docs about the possible error domains, closed bgo #560147

diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index 7c1c6701fb610272971d493fce6099efb129af56..35f0271ccd67569b4e5e0b912a72e44528f7d13d 100644 (file)
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -643,6 +643,10 @@ gtk_builder_new (void)
  * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder 
  * UI definition</link> and merges it with the current contents of @builder. 
  * 
+ * Upon errors 0 will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR 
+ * domain.
+ *
  * Returns: A positive value on success, 0 if an error occurred
  *
  * Since: 2.12
@@ -698,6 +702,10 @@ gtk_builder_add_from_file (GtkBuilder   *builder,
  * UI definition</link> building only the requested objects and merges
  * them with the current contents of @builder. 
  *
+ * Upon errors 0 will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR 
+ * domain.
+ *
  * <note><para>
  * If you are adding an object that depends on an object that is not 
  * its child (for instance a #GtkTreeView that depends on its
@@ -760,6 +768,9 @@ gtk_builder_add_objects_from_file (GtkBuilder   *builder,
  * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder 
  * UI definition</link> and merges it with the current contents of @builder. 
  *
+ * Upon errors 0 will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
+ *
  * Returns: A positive value on success, 0 if an error occurred
  *
  * Since: 2.12
@@ -805,6 +816,9 @@ gtk_builder_add_from_string (GtkBuilder   *builder,
  * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder 
  * UI definition</link> building only the requested objects and merges
  * them with the current contents of @builder. 
+ *
+ * Upon errors 0 will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
  * 
  * <note><para>
  * If you are adding an object that depends on an object that is not 
@@ -1121,6 +1135,9 @@ gtk_builder_connect_signals_full (GtkBuilder            *builder,
  * #GtkAdjustment type values. Support for #GtkWidget type values is
  * still to come.
  *
+ * Upon errors %FALSE will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR domain.
+ *
  * Returns: %TRUE on success
  *
  * Since: 2.12
@@ -1170,6 +1187,9 @@ gtk_builder_value_from_string (GtkBuilder   *builder,
  * This function calls g_value_init() on the @value argument, so it 
  * need not be initialised beforehand.
  *
+ * Upon errors %FALSE will be returned and @error will be assigned a
+ * #GError from the #GTK_BUILDER_ERROR domain.
+ *
  * Returns: %TRUE on success
  *
  * Since: 2.12