[gtk-doc] docs: clarify link between SECTION:tag and FILE in -section.txt. Fixes #594224
- From: Stefan Kost <stefkost src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk-doc] docs: clarify link between SECTION:tag and FILE in -section.txt. Fixes #594224
- Date: Tue, 29 Sep 2009 13:38:23 +0000 (UTC)
commit d8c1ba2fe23b901512a3383c0ac87c52be470701
Author: Stefan Kost <ensonic users sf net>
Date: Tue Sep 29 16:35:25 2009 +0300
docs: clarify link between SECTION:tag and FILE in -section.txt. Fixes #594224
Also fix the spelling of the sections.txt file.
help/manual/C/gtk-doc-manual.xml | 17 ++++++++++++++---
1 files changed, 14 insertions(+), 3 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index 6151481..015d400 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -709,6 +709,17 @@ make
<variablelist>
<varlistentry>
+ <term>SECTION:<name></term>
+ <listitem>
+ <para>
+ The name links the section documentation to the respective part in
+ the <filename><package>-sections.txt</filename> file. The
+ name give here should match the <FILE> tag in the
+ <filename><package>-sections.txt</filename> file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>@short_description</term>
<listitem>
<para>
@@ -1288,7 +1299,7 @@ gtk_arrow_get_type
<para>
The <filename><package>-undeclared.txt</filename> file lists symbols
- given in the <filename><package>-section.txt</filename> but not
+ given in the <filename><package>-sections.txt</filename> but not
found in the sources. Check if they have been removed or if they are
misspelled.
</para>
@@ -1297,7 +1308,7 @@ gtk_arrow_get_type
The <filename><package>-unused.txt</filename> file lists symbol
names, where the Gtk-Doc scanner has found documentation, but does not
know where to put it. This means that the symbol has not yet been added to
- the <filename><package>-section.txt</filename> file.
+ the <filename><package>-sections.txt</filename> file.
</para>
<tip>
@@ -1354,7 +1365,7 @@ gtk_arrow_get_type
<!-- docbook warnings: -->
<seglistitem>
<seg>multiple "IDs" for constraint linkend: XYZ</seg>
- <seg>Symbol XYZ appears twice in -section.txt file.</seg>
+ <seg>Symbol XYZ appears twice in -sections.txt file.</seg>
</seglistitem>
<seglistitem>
<seg>Element typename in namespace '' encountered in para, but no template matches.</seg>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]