Documentando o código
GTK-Doc usa comentários do código fonte com uma sintaxe especial para documentação do código. Além disso, ele obtém informações sobre a estrutura do seu projeto a partir de outros fontes. Na próxima seção, você vai descobrir todas as informações sobre a sintaxe dos comentários.
Antigamente, a maioria das documentações tinha que ser preenchida em arquivos residentes dentro do diretório tmpl. Isso tem as desvantagens das informações frequentemente não serem atualizadas e também que o arquivo tende a causar conflitos com sistemas de controle de versão.
Para evitar os problemas mencionados a seguir nós sugerimos que a documentação seja colocada dentro das fontes. Este manual vai apenas descrever esta forma de documentar código.
A varredura sabe lidar com a maioria dos cabeçalhos de C sem problemas. Caso se receba avisos (warnings) na varredura que pareça ser um caso especial, pode-se informar ao GTK-Doc para ignorá-los.
#ifndef __GTK_DOC_IGNORE__ /* código não analisável arqui */ #endif
- 3.1. Comentários de documentação
- 3.2. Documentando seções
- 3.3. Documentando símbolos
- 3.4. Tags úteis do DocBook