Dokumentování v kódu

GTK-Doc používá pro kód dokumentace komentáře se speciální syntaxí ve zdrojovém kódu. K tomu se ještě získávají informace o struktuře vašeho projektu z dalších zdrojů. V následujícím oddílu najdete všechny informace o syntaxi komentářů.

Umístění dokumentace

Dříve musela být většina dokumentace doplněná do souborů umístěných ve složce tmpl. Následkem toho bylo, že informace byly často neaktualizované a soubory měli tendenci způsobovat konflikty v systémech pro správu verzí.

Aby se předešlo těmto zmiňovaným problémům, předpokládáme vkládání dokumentace přímo do zdrojových kódů. Tato příručka bude popisovat pouze tento způsob dokumentování kódu.

Skener zvládá dobře většinu hlavičkových souborů C. V případě, že od něj obdržíte varování, které vypadá jako speciální případ, můžete GTK-Doc poradit, aby jej přeskakovala.

Příklad 3-1Komentářový blok GTK-Doc
#ifndef __GTK_DOC_IGNORE__
/* kód zde se nezpracovává */
#endif

Omezení

Uvědomte si, že GTK-Doc podporuje #ifndef(__GTK_DOC_IGNORE__), ale ne #if !defined(__GTK_DOC_IGNORE__) nebo jiné kombinace.