[gtkmm-documentation] Appendix G: Add _WRAP_ENUM_DOCS_ONLY() documentation.
- From: José Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Appendix G: Add _WRAP_ENUM_DOCS_ONLY() documentation.
- Date: Sun, 30 Jun 2013 22:06:00 +0000 (UTC)
commit 94e7363f6923efb96acffef30949739befa9ea13
Author: José Alburquerque <jaalburquerque gmail com>
Date: Sun Jun 30 14:28:39 2013 -0400
Appendix G: Add _WRAP_ENUM_DOCS_ONLY() documentation.
* docs/tutorial/C/gtkmm-tutorial-in.xml: Add a section describing what
the _WRAP_ENUM_DOCS_ONLY() macro does in the "Other macros" section of
the "The .hg and .ccg files" section in the wrapping appendix so the
macro can be documented for future use.
docs/tutorial/C/gtkmm-tutorial-in.xml | 13 +++++++++++++
1 files changed, 13 insertions(+), 0 deletions(-)
---
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index 442e048..06800d2 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -9728,6 +9728,19 @@ _WRAP_ENUM(IconLookupFlags, GtkIconLookupFlags, NO_GTYPE)
</para>
</sect3>
+<sect3 id="gmmproc-wrap-enum-docs-only">
+<title>_WRAP_ENUM_DOCS_ONLY</title>
+<para>This macro just generates a Doxygen documentationn block for the enum.
+ This is useful for enums that can't be wrapped with
+ <function>_WRAP_ENUM()</function> because they are complexly defined (maybe
+ using C macros) but including the generated enum documentation is still
+ desired. It is used with the same syntax as
+ <function>_WRAP_ENUM()</function> and also process the same options (though
+ NO_GTYPE is just ignored because it makes no differene when just generating
+ the enumm's documentation).
+</para>
+</sect3>
+
<sect3 id="gmmproc-wrap-gerror">
<title>_WRAP_GERROR</title>
<para>This macro generates a C++ exception class, derived from Glib::Error, with
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]