[gtkmm-documentation] Update description of the errthrow parameter in _WRAP_METHOD
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Update description of the errthrow parameter in _WRAP_METHOD
- Date: Fri, 29 Sep 2017 14:07:08 +0000 (UTC)
commit 8feeb4782831eeae99be457a7ef2e78f4a096544
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Fri Sep 29 16:04:55 2017 +0200
Update description of the errthrow parameter in _WRAP_METHOD
In _WRAP_METHOD[_DOCS_ONLY], the errthrow parameter can now contain an
optional list of exceptions. Bug 787979
docs/tutorial/C/index-in.docbook | 20 ++++++++++++++++----
1 files changed, 16 insertions(+), 4 deletions(-)
---
diff --git a/docs/tutorial/C/index-in.docbook b/docs/tutorial/C/index-in.docbook
index 2b0c8f4..b9f48cc 100644
--- a/docs/tutorial/C/index-in.docbook
+++ b/docs/tutorial/C/index-in.docbook
@@ -9842,10 +9842,16 @@ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)
</listitem>
</varlistentry>
<varlistentry>
- <term>errthrow</term>
+ <term>errthrow ["<exceptions>"]</term>
<listitem>
<para>Use the last GError** parameter of the C function to
- throw an exception.</para>
+ throw an exception.
+ The optional "<exceptions>" is a comma-separated list
+ of exceptions that can be thrown. It determines which @throws
+ Doxygen commands are added to the documentation. Default value
+ is <classname>Glib::Error</classname>. If you want a comma in
+ the description of an exception, precede it by a backslash. Example:
+
<code>errthrow "Glib::OptionError Hello\, world, Glib::ConvertError"</code></para>
</listitem>
</varlistentry>
<varlistentry>
@@ -9959,10 +9965,16 @@ _WRAP_METHOD_DOCS_ONLY(gtk_container_add)
<para>There are some optional extra arguments:
<variablelist>
<varlistentry>
- <term>errthrow</term>
+ <term>errthrow ["<exceptions>"]</term>
<listitem>
<para>Excludes documentation of the last GError** parameter of
- the C function.</para>
+ the C function.
+ The optional "<exceptions>" is a comma-separated list
+ of exceptions that can be thrown. It determines which @throws
+ Doxygen commands are added to the documentation. Default value
+ is <classname>Glib::Error</classname>. If you want a comma in
+ the description of an exception, precede it by a backslash. Example:
+
<code>errthrow "Glib::OptionError Hello\, world, Glib::ConvertError"</code></para>
</listitem>
</varlistentry>
<varlistentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]