[gtkmm-documentation] _WRAP_CTOR: Document the new "errthrow" extra argument option.



commit da0c6b5987822f0215e1c13c65957f625096f8d2
Author: Josà Alburquerque <jaalburqu svn gnome org>
Date:   Sun Nov 11 15:38:25 2012 -0500

    _WRAP_CTOR: Document the new "errthrow" extra argument option.
    
    	* docs/tutorial/C/gtkmm-tutorial-in.xml (_WRAP_CTOR): Add
    	documentation describing what the extra "errthrow" option is used for.

 ChangeLog                             |    7 +++++++
 docs/tutorial/C/gtkmm-tutorial-in.xml |   12 ++++++++++++
 2 files changed, 19 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 9dd0f3a..99ba6d2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2012-11-11  Josà Alburquerque  <jaalburquerque gmail com>
+
+	_WRAP_CTOR: Document the new "errthrow" extra argument option.
+
+	* docs/tutorial/C/gtkmm-tutorial-in.xml (_WRAP_CTOR): Add
+	documentation describing what the extra "errthrow" option is used for.
+
 2012-10-04  Josà Alburquerque  <jaalburquerque gmail com>
 
 	_WRAP_METHOD: Document gmmproc's output parameter functionality.
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index 8be8909..b15dcf1 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -8907,6 +8907,18 @@ public:
   constructor with the same argument types. It takes a C++ constructor
   signature, and a C function name.
 </para>
+
+<para>It also takes an optional extra argument:
+  <variablelist>
+    <varlistentry>
+        <term>errthrow</term>
+        <listitem>
+          <para>This tells gmmproc that the C <function>*_new()</function> has
+            a final GError** parameter which should be ignored.</para>
+        </listitem>
+    </varlistentry>
+  </variablelist>
+</para>
 <para>
   When wrapping constructors, it is possible for gmmproc to generate
   convenience overloads of the wrapped constructors if the C function has



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