Užitečné značky DocBook
Zde jsou některé značky DocBook, které mají pro dokumentaci kódu největší význam.
Odkaz na jiný oddíl v dokumentaci GTK:
<link linkend="glib-Hash-Tables">Hašovací tabulky</link>
Odkaz na externí funkci, například standardní funkci C:
<function>…</function>
Vložení ukázky kódu:
<example> <title>Používání GHashTable.</title> <programlisting> … </programlisting> </example>
<informalexample> <programlisting> … </programlisting> </informalexample>
Vložení seznamu s odrážkami:
<itemizedlist> <listitem> <para> … </para> </listitem> <listitem> <para> … </para> </listitem> </itemizedlist>
Vložení poznámky, která se objeví mimo text:
<note> <para> Ujistěte se, že data po použití uvolníte. </para> </note>
Odkaz na typ:
<type>unsigned char</type>
Odkaz na externí strukturu (která není popsaná v dokumentaci GTK):
<structname>XFontStruct</structname>
Odkaz na pole struktury:
<structfield>len</structfield>
Pro odkaz na název třídy by se dal nejspíše použít:
<classname>GtkWidget</classname>
Zvýrazněný text:
<emphasis>Toto je důležité</emphasis>
Pro název souboru použijte:
<filename>/home/user/documents</filename>
Odkaz na použití klávesy:
<keycombo><keycap>Ctrl</keycap><keycap>L</keycap></keycombo>