[gtkmm] Builder: Complete the exceptions thrown documentation.



commit def6a267cd7a8dbdc8acb9f0348f44278cf59641
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Apr 7 15:39:43 2010 +0200

    Builder: Complete the exceptions thrown documentation.
    
    * gtk/src/builder.hg: Completed the @throws lines now that GtkBuilder
        has documentation about the GError domains that it throws.
        This fixed bug #548022 (Alexander Shaduri).

 ChangeLog          |    8 ++++++
 gtk/src/builder.hg |   68 +++++++++++++++++++++++++++++----------------------
 2 files changed, 47 insertions(+), 29 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 625a5a1..77bedad 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2010-04-07  Murray Cumming  <murrayc murrayc com>
+
+    Builder: Complete the exceptions thrown documentation.
+
+	* gtk/src/builder.hg: Completed the @throws lines now that GtkBuilder 
+    has documentation about the GError domains that it throws.
+    This fixed bug #548022 (Alexander Shaduri).
+
 2010-04-07  Murray Cumming  <murrayc mmurrayc com>
 
     API reference documentation: Remove gobjection-introspection annotations.
diff --git a/gtk/src/builder.hg b/gtk/src/builder.hg
index e170ffe..e13212c 100644
--- a/gtk/src/builder.hg
+++ b/gtk/src/builder.hg
@@ -56,7 +56,7 @@ public:
    *
    * @param filename the name of the file to parse.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::FileError, Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::FileError
    *
    * @newin{2,12}
    */
@@ -76,7 +76,7 @@ public:
    * @param filename the name of the file to parse.
    * @param object_id The object to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::FileError, Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::FileError
    *
    * @newin{2,14}
    */
@@ -96,7 +96,7 @@ public:
    * @param filename the name of the file to parse.
    * @param object_id The object to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::FileError, Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::FileError
    *
    * @newin{2,16}
    */
@@ -114,7 +114,7 @@ public:
    * @param filename the name of the file to parse.
    * @param object_ids The objects to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::FileError, Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::FileError
    *
    * @newin{2,14}
    */
@@ -128,7 +128,7 @@ public:
    *
    * @param buffer: the string to parse
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,12}
    */
@@ -145,17 +145,14 @@ public:
    * @param buffer The string to parse.
    * @param object_id The object to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,16}
    */
 #ifdef GLIBMM_EXCEPTIONS_ENABLED
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const char* object_id);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const char* object_id);
 #else
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const char* object_id,
-																									std::auto_ptr<Glib::Error>& error);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const char* object_id, std::auto_ptr<Glib::Error>& error);
 #endif /* !GLIBMM_EXCEPTIONS_ENABLED */
 
   /** Parses a string containing a GtkBuilder UI definition building only the requested object.
@@ -163,17 +160,14 @@ public:
    * @param buffer The string to parse.
    * @param object_id The object to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,14}
    */
 #ifdef GLIBMM_EXCEPTIONS_ENABLED
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const Glib::ustring& object_id);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::ustring& object_id);
 #else
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const Glib::ustring& object_id,
-																									std::auto_ptr<Glib::Error>& error);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::ustring& object_id, std::auto_ptr<Glib::Error>& error);
 #endif /* !GLIBMM_EXCEPTIONS_ENABLED */
 
   /** Parses a string containing a GtkBuilder UI definition building only the requested objects.
@@ -185,20 +179,26 @@ public:
    * @param buffer the string to parse
    * @param object_ids The objects to build.
    * @result A new Builder object, or a null pointer if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,14}
    */
 #ifdef GLIBMM_EXCEPTIONS_ENABLED
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const Glib::StringArrayHandle& object_ids);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::StringArrayHandle& object_ids);
 #else
-  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer,
-																									const Glib::StringArrayHandle& object_ids,
-																									std::auto_ptr<Glib::Error>& error);
+  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::StringArrayHandle& object_ids, std::auto_ptr<Glib::Error>& error);
 #endif /* !GLIBMM_EXCEPTIONS_ENABLED */
   _IGNORE(gtk_builder_add_objects_from_file)
 
+  /** Parses a file containing a GtkBuilder UI definition, 
+   * and merges it with the current contents of the builder.
+   *
+   * @param buffer The file to parse.
+   * @result true on success or false if an error occurred.
+   * @throws BuilderError, Glib::MarkupError, Glib::MarkupError
+   *
+   * @newin{2,14}
+   */
   _WRAP_METHOD(bool add_from_file(const std::string& filename), gtk_builder_add_from_file, errthrow)
 
   //This is just to avoid the ambiguous call when using a string literal, 
@@ -214,7 +214,7 @@ public:
    * @param buffer The file to parse.
    * @param The object to build.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::MarkupError
    *
    * @newin{2,16}
    */
@@ -235,7 +235,7 @@ public:
    * @param buffer The file to parse.
    * @param The object to build.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError, Glib::MarkupError
    *
    * @newin{2,14}
    */
@@ -255,7 +255,7 @@ public:
    *
    * @param buffer The string to parse.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,12}
    */
@@ -272,7 +272,7 @@ public:
    * @param buffer The string to parse.
    * @param The object to build.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,16}
    */
@@ -289,7 +289,7 @@ public:
    * @param buffer The string to parse.
    * @param The object to build.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,14}
    */
@@ -306,7 +306,7 @@ public:
    * @param buffer The string to parse.
    * @param The objects to build.
    * @result true on success or false if an error occurred.
-   * @throws Glib::MarkupError
+   * @throws BuilderError, Glib::MarkupError
    *
    * @newin{2,14}
    */
@@ -317,6 +317,16 @@ public:
   #endif //GLIBMM_EXCEPTIONS_ENABLED
   _IGNORE(gtk_builder_add_objects_from_string)
 
+  /** Parses a string containing a GtkBuilder UI definition 
+   * and merges it with the current contents of the builder.
+   *
+   * @param buffer The string to parse.
+   * @param length The length of @a buffer (may be -1 if @buffer is nul-terminated).
+   * @result true on success or false if an error occurred.
+   * @throws BuilderError, Glib::MarkupError
+   *
+   * @newin{2,12}
+   */
   _WRAP_METHOD(bool add_from_string(const char* buffer, gsize length), gtk_builder_add_from_string, errthrow)
 
   //TODO: Custom-implement this and prevent it from being used with GTK_WIDGET-derived types?



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]