Användbara DocBook-taggar
Här är några DocBook-taggar som är användbara när man dokumenterar koden.
För att länka till ett annat avsnitt i GTK-dokumentationen:
<link linkend="glib-Hash-Tables">Hashtabeller</link>
För att referera till en extern funktion, t.ex. en standardfunktion i C:
<function>…</function>
För att inkludera exempelkod:
<example> <title>Att använda en hashtabell.</title> <programlisting> … </programlisting> </example>
<informalexample> <programlisting> … </programlisting> </informalexample>
För att inkludera punktlistor:
<itemizedlist> <listitem> <para> … </para> </listitem> <listitem> <para> … </para> </listitem> </itemizedlist>
För att inkludera en not som skiljer sig från texten:
<note> <para> Säkerställ att du frigjort data efter användning. </para> </note>
För att refera till en typ:
<type>unsigned char</type>
För att referera till en extern struktur (som inte beskrivs i GTK-dokumentationen):
<structname>XFontStruct</structname>
För att referera till ett fält för en struktur:
<structfield>len</structfield>
För att referera till ett klassnamn kan vi möjligen använda:
<classname>GtkWidget</classname>
För att betona text:
<emphasis>Detta är viktigt</emphasis>
För filnamn använd:
<filename>/home/användare/dokument</filename>
För att referera till tangenter använd:
<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>