Att dokumentera koden

GTK-Doc använder källkodskommentarer med en speciell syntax för koddokumentation. Vidare så hämtar det information om din projektstruktur från olika källor. Under nästa avsnitt kommer du att hitta information om syntaxen i kommentarerna.

Dokumentationsplacering

Tidigare var det tvunget att fylla i största delen av dokumentationen i filer som fanns i katalogen tmpl. Detta hade nackdelen att informationen ofta inte uppdaterades och att filen också ofta orsakade konflikter med versionshanteringssystem.

För att undvika de nämnda problemen föreslår vi att placera dokumentationen i källkoden. Denna manual kommer endast att beskriva detta sättet att dokumentera kod.

Detektorn kan hantera majoriteten av C-huvuden bra. I det fall när du får varningar från detektorn som ser ut som ett specialfall, kan du tipsa GTK-Doc att hoppa över dem.

Exempel 3-1GTK-Doc-kommentarsblock
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif

Begränsningar

Notera att GTK-Doc har stöd för #ifndef(__GTK_DOC_IGNORE__) men inte #if !defined(__GTK_DOC_IGNORE__) eller andra kombinationer.