[gtk-doc] Add an example about documenting enums
- From: Stefan Kost <stefkost src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk-doc] Add an example about documenting enums
- Date: Thu, 24 Dec 2009 20:31:30 +0000 (UTC)
commit d78ead988e4730fde9975012ab70834981dd90d5
Author: Javier Jardón <jjardon gnome org>
Date: Wed Dec 23 07:03:32 2009 +0100
Add an example about documenting enums
help/manual/C/gtk-doc-manual.xml | 20 ++++++++++++++++++++
1 files changed, 20 insertions(+), 0 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index 3dd2b21..bf8fae7 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -972,6 +972,26 @@ typedef struct _FooWidget {
} FooWidget;
]]></programlisting>
</example>
+
+ <example><title>Enum comment block</title>
+ <programlisting>
+<![CDATA[
+/**
+ * Something:
+ * @SOMETHING_FOO: something foo
+ * @SOMETHING_BAR: something bar
+ *
+ * Enum values used for the thing, to specify the thing.
+ *
+ **/
+typedef enum {
+ SOMETHING_FOO,
+ SOMETHING_BAR,
+} Something;
+]]>
+ </programlisting>
+ </example>
+
</sect1>
<sect1 id="documenting_docbook">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]