[gtkmm-documentation] Wrapping Section: Use {OUT} instead of {RET} for output params.
- From: Josà Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Wrapping Section: Use {OUT} instead of {RET} for output params.
- Date: Tue, 11 Oct 2011 20:36:30 +0000 (UTC)
commit 3d12885addb3eb6b12b5eab10e81820980fe084c
Author: Josà Alburquerque <jaalburqu svn gnome org>
Date: Tue Oct 11 16:24:03 2011 -0400
Wrapping Section: Use {OUT} instead of {RET} for output params.
* docs/tutorial/C/gtkmm-tutorial-in.xml (_WRAP_METHOD): Explain that
{OUT} appended to a parameter name (instead of {RET}) signifies that
it is an output parameter because it is probably be more intuitive.
ChangeLog | 8 ++++++++
docs/tutorial/C/gtkmm-tutorial-in.xml | 6 +++---
2 files changed, 11 insertions(+), 3 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 855e077..8878a15 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2011-10-11 Josà Alburquerque <jaalburqu svn gnome org>
+
+ Wrapping Section: Use {OUT} instead of {RET} for output params.
+
+ * docs/tutorial/C/gtkmm-tutorial-in.xml (_WRAP_METHOD): Explain that
+ {OUT} appended to a parameter name (instead of {RET}) signifies that
+ it is an output parameter because it is probably be more intuitive.
+
2011-10-09 Kjell Ahlstedt <kjell ahlstedt bredband net>
Update Appendix F and G to gtkmm3 status.
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index 320c698..4369d62 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -8876,7 +8876,7 @@ _WRAP_METHOD(void set_device_events(Gdk::EventMask events{.}, const Glib::RefPtr
output parameter in the C++ method declaration in which the return of the C
function would be placed and to have the C++ method return <type>void</type>.
To do that, simply include the output parameter declaration in the C++ method
- declaration appending a <literal>{RET}</literal> to the output parameter
+ declaration appending a <literal>{OUT}</literal> to the output parameter
name. For example, if <function>gtk_widget_get_request_mode()</function> is
declared as the following:
<programlisting>
@@ -8886,9 +8886,9 @@ GtkSizeRequestMode gtk_widget_get_request_mode(GtkWidget* widget);
returning a <type>SizeRequestMode</type>, something like the following could
be used:
<programlisting>
-_WRAP_METHOD(void get_request_mode(SizeRequestMode& mode{RET}) const, gtk_widget_get_request_mode)
+_WRAP_METHOD(void get_request_mode(SizeRequestMode& mode{OUT}) const, gtk_widget_get_request_mode)
</programlisting>
- the <literal>{RET}</literal> appended to the name of the
+ the <literal>{OUT}</literal> appended to the name of the
<parameter>mode</parameter> output parameter tells gmmproc to place the
return of the C function in that output parameter. In this case, however, a
necessary initialization macro like the following would also have to be
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]