[gtk-doc] docs: document remaining section docs fields
- From: Stefan Kost <stefkost src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk-doc] docs: document remaining section docs fields
- Date: Sat, 19 Dec 2009 21:13:18 +0000 (UTC)
commit c2ea2bbeee9edeec7fe232c9ee1204152ce045a2
Author: Stefan Kost <ensonic users sf net>
Date: Sat Dec 19 23:11:21 2009 +0200
docs: document remaining section docs fields
The docs where missing @title and @section_id description.
help/manual/C/gtk-doc-manual.xml | 28 ++++++++++++++++++++++------
1 files changed, 22 insertions(+), 6 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index 70d875b..067b929 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -707,6 +707,7 @@ make
Each section of the documentation contains information about one class
or module. To introduce the component one can write a section block.
The short description is also used inside the table of contents.
+ All the @fields are optional.
</para>
<para>
@@ -716,6 +717,8 @@ make
/**
* SECTION:meepapp
* @short_description: the application class
+ * @title: Meep application
+ * @section_id:
* @see_also: #MeepSettings
* @stability: Stable
* @include: meep/app.h
@@ -749,6 +752,25 @@ make
</listitem>
</varlistentry>
<varlistentry>
+ <term>@title</term>
+ <listitem>
+ <para>
+ The section title defaults to <name> from the SECTION
+ declaration. It can be overridden with the @title field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>@section_id</term>
+ <listitem>
+ <para>
+ Overrides the use of title as a section identifier. For GObjects
+ the <title> is used as a section_id and for other section it
+ is <MODULE>-<title>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>@see_also</term>
<listitem>
<para>
@@ -821,12 +843,6 @@ make
</varlistentry>
</variablelist>
- <para>
- FIXME
- having @title here, would put this title into a newly generated section
- file, but later would be obsolete (right?)
- </para>
-
<tip>
<para>
To avoid unnecessary recompilation after doc-changes put the section
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]