[gtkmm-documentation] Improve the description of parameters in the _WRAP macros
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Improve the description of parameters in the _WRAP macros
- Date: Thu, 21 May 2015 06:59:33 +0000 (UTC)
commit 362eecfdfa69537165cdba4e77c10a93050d1517
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Thu May 21 08:56:59 2015 +0200
Improve the description of parameters in the _WRAP macros
* docs/tutorial/C/index-in.docbook: "The .hg and .ccg files" section:
Note which optional parameters have a variable part, such as newin "<version>".
docs/tutorial/C/index-in.docbook | 67 ++++++++++++++++++++++++++++---------
1 files changed, 50 insertions(+), 17 deletions(-)
---
diff --git a/docs/tutorial/C/index-in.docbook b/docs/tutorial/C/index-in.docbook
index a9a4091..b86c63c 100644
--- a/docs/tutorial/C/index-in.docbook
+++ b/docs/tutorial/C/index-in.docbook
@@ -9383,7 +9383,7 @@ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)
</listitem>
</varlistentry>
<varlistentry>
- <term>deprecated</term>
+ <term>deprecated ["<text>"]</term>
<listitem>
<para>Puts the generated code in #ifdef blocks. Text about the
deprecation can be specified as an optional
@@ -9398,20 +9398,20 @@ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)
</listitem>
</varlistentry>
<varlistentry>
- <term>newin</term>
+ <term>newin "<version>"</term>
<listitem>
<para>Adds a @newin Doxygen command to the documentation, or replaces
the @newin command generated from the C documentation.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ifdef</term>
+ <term>ifdef <identifier></term>
<listitem>
<para>Puts the generated code in #ifdef blocks.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>slot_name</term>
+ <term>slot_name <parameter_name></term>
<listitem>
<para>Specifies the name of the slot parameter of the method, if it
has one. This enables <command>gmmproc</command> to generate code
@@ -9423,7 +9423,7 @@ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)
</listitem>
</varlistentry>
<varlistentry>
- <term>slot_callback</term>
+ <term>slot_callback <function_name></term>
<listitem>
<para>Used in conjunction with the <literal>slot_name</literal>
option to specify the name of the glue callback function that
@@ -9501,7 +9501,7 @@ _WRAP_METHOD_DOCS_ONLY(gtk_container_remove)
</listitem>
</varlistentry>
<varlistentry>
- <term>newin</term>
+ <term>newin "<version>"</term>
<listitem>
<para>Adds a @newin Doxygen command to the documentation, or replaces
the @newin command generated from the C documentation.</para>
@@ -9588,22 +9588,31 @@ _WRAP_SIGNAL(void clicked(),"clicked")
</listitem>
</varlistentry>
<varlistentry>
- <term>newin</term>
+ <term>deprecated ["<text>"]</term>
+ <listitem>
+ <para>Puts the generated code in #ifdef blocks. Text about the
+ deprecation can be specified as an optional parameter.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>newin "<version>"</term>
<listitem>
<para>Adds a @newin Doxygen command to the documentation, or replaces
the @newin command generated from the C documentation.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ifdef</term>
+ <term>ifdef <identifier></term>
<listitem>
<para>Puts the generated code in #ifdef blocks.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>exception_handler</term>
+ <term>exception_handler <method_name></term>
<listitem>
- <para>Allows to use custom exception handler instead of default one. Exception might be
rethrown by user-defined handler, and it will be catched by default handler.</para>
+ <para>Allows to use custom exception handler instead of default one.
+ Exception might be rethrown by user-defined handler, and it will be
+ caught by default handler.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -9622,6 +9631,17 @@ _WRAP_SIGNAL(void clicked(),"clicked")
_WRAP_PROPERTY("label", Glib::ustring)
</programlisting>
</para>
+<para>There is one optional extra argument:
+<variablelist>
+ <varlistentry>
+ <term>deprecated ["<text>"]</term>
+ <listitem>
+ <para>Puts the generated code in #ifdef blocks. Text about the
+ deprecation can be specified as an optional parameter.</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</para>
</sect3>
<sect3 id="gmmproc-wrap-vfunc">
@@ -9689,13 +9709,13 @@ _WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)
</listitem>
</varlistentry>
<varlistentry>
- <term>ifdef</term>
+ <term>ifdef <identifier></term>
<listitem>
<para>Puts the generated code in #ifdef blocks.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>slot_name</term>
+ <term>slot_name <parameter_name></term>
<listitem>
<para>Specifies the name of the slot parameter of the method, if it
has one. This enables <command>gmmproc</command> to generate code
@@ -9707,7 +9727,7 @@ _WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)
</listitem>
</varlistentry>
<varlistentry>
- <term>slot_callback</term>
+ <term>slot_callback <function_name></term>
<listitem>
<para>Used in conjunction with the <literal>slot_name</literal>
option to specify the name of the glue callback function that
@@ -9727,15 +9747,17 @@ _WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)
</listitem>
</varlistentry>
<varlistentry>
- <term>return_value</term>
+ <term>return_value <value></term>
<listitem>
<para>Defines non-default return value.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>exception_handler</term>
+ <term>exception_handler <method_name></term>
<listitem>
- <para>Allows to use custom exception handler instead of default one. Exception might be
rethrown by user-defined handler, and it will be catched by default handler.</para>
+ <para>Allows to use custom exception handler instead of default one.
+ Exception might be rethrown by user-defined handler, and it will be
+ caught by default handler.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -9763,6 +9785,17 @@ _WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)
_WRAP_CHILD_PROPERTY("tab-expand", bool)
</programlisting>
</para>
+<para>There is one optional extra argument:
+<variablelist>
+ <varlistentry>
+ <term>deprecated ["<text>"]</term>
+ <listitem>
+ <para>Puts the generated code in #ifdef blocks. Text about the
+ deprecation can be specified as an optional parameter.</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</para>
</sect3>
</sect2>
@@ -9781,7 +9814,7 @@ _IMPLEMENTS_INTERFACE(Activatable)
<para>There is one optional extra argument:
<variablelist>
<varlistentry>
- <term>ifdef</term>
+ <term>ifdef <identifier></term>
<listitem>
<para>Puts the generated code in #ifdef blocks.</para>
</listitem>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]