Doxygen Tutorial

DOXYGEN

Tutorial de documentação de códigos usando a ferramenta Doxygen no Windows

O QUE É:

O Doxygen é um programa que gera a documentação de um programa a partir da análise de um código

escrito em C (ou linguagens derivadas como C++, Java ou C#). Nesses códigos são reconhecidas

estruturas de dados, funções e comentários feitos com uma sintaxe especial.

Download do Doxygen

COMO FUNCIONA:

O Doxygen analisa o código e gera um arquivo no formato CHM (Compiled HTML Help), mas para isso

você deve instalar o Microsoft HTML Help que pode ser baixado aqui ou aqui

.

COMENTANDO UM CÓDIGO:

Para usar o Doxygen, você deve comentar seu código de maneira diferente da usual (// ou /**/).

Os exemplos mais comuns de comentários reconhecidos pelo doxygen são:

/// COMENTÁRIO

/**

* COMENTÁRIO

*/

//! COMENTÁRIO

int variável; /*!< COMENTARIO SOBRE A VARIAVEL */

Mais tipos (comentários de funções, por exemplo) podem ser facilmente encontrados na internet.

CONFIGURANDO O DOXYWIZARD:

Em Wizard:

Project:

•

Project name: nome do seu projeto.

•

Source Code Directory: diretório onde estão as fontes.

•

Destination Directory: diretório onde será colocada a documentação.

Mode:

•

Selecione ALL ENTITIES, INCLUDE CROSS-REFERENCED SOURCE e OPTIMIZE FOR C OUTPUT.

Output:

•

Em HTML, selecione PREPARE FOR COMPRESSED HTML (.CHM).

•

Desmarque os demais formatos.

Diagrams:

•

Selecione NO DIAGRAMS.

Em Expert:

Project:

•

Selecionar OUTPUT_LANGUAGE Brazilian.

•

Desmarcar FULL_PATH_NAMES.

Build:

•

marcar INTERNAL_DOCS.

Input:

•

INPUT_ENCODING: trocar UTF-8 por char.

HTML:

•

CHM_FILE: colocar o nome do arquivo CHM a gerar.

Salvar as configurações (Save) e clicar em “Run Doxygen” na aba “Run”.

CRIANDO O ARQUIVO .CHM

Se tudo der certo, será criada uma pasta “html” no seu diretório de saída e dentro dessa pasta está um

arquivo .hhp. Duplo clique para abrir o Help Workshop. Selecione “File Compile” ou clique no ícone de

“moedor de carne”. No diretório “html” será criado um arquivo .chm. Abra o arquivo para ver o

resultado final. Essa é a documentação do seu código.

FIGURA 1 - HTML Help Workshop

FIGURA 2 - RESULTADO FINAL