[gtk-doc] Add more info about the struct documentation options
- From: Stefan Kost <stefkost src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk-doc] Add more info about the struct documentation options
- Date: Thu, 24 Dec 2009 20:31:35 +0000 (UTC)
commit 8e49176d1f5d19c16d6ef8ee5bca0777fd57f9f3
Author: Javier Jardón <jjardon gnome org>
Date: Wed Dec 23 07:09:50 2009 +0100
Add more info about the struct documentation options
Add info about /*< private >*/ and /*< public >*/ usage
help/manual/C/gtk-doc-manual.xml | 16 ++++++++++++----
1 files changed, 12 insertions(+), 4 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index bf8fae7..7d91812 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -1,8 +1,8 @@
<?xml version="1.0" standalone="no"?>
<?xml-stylesheet type="text/xml" href="params.xsl"?>
<!-- vim: set ai tw=80 ts=3 sw=3: -->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "
- http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "
+ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY FDL SYSTEM "fdl-appendix.xml">
<!ENTITY FDLlink "<link linkend='fdl'>included</link>">
@@ -956,7 +956,7 @@ foo_signals[FOOBARIZE] =
]]></programlisting>
</example>
- <example><title>Struct comment block</title>
+ <example><title>Struct comment block</title>
<programlisting>
<![CDATA[
/**
@@ -966,11 +966,19 @@ foo_signals[FOOBARIZE] =
* This is the best widget, ever.
*/
typedef struct _FooWidget {
+ /*< private >*/
GtkWidget parent;
+
/*< public >*/
gboolean bar;
} FooWidget;
-]]></programlisting>
+]]>
+ </programlisting>
+ <para>
+ Use <code>/*< private >*/</code> before the private struct fields you
+ you want to hide. Use <code>/*< public >*/</code> for the reverse
+ behavirour.
+ </para>
</example>
<example><title>Enum comment block</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]