Guia de Utilização do Doxygen

Doxygen

Doxygen é um gerador de documentação para C++, C, Java, Objective-C, etc. Maiores informações sobre o Doxygen podem ser encontradas em Homepage.

Instalando o Doxygen

Provavelmente o Doxygen já está isntalado em sua máquina, caso não esteja realize os passo abaixo (precisa ser root):

su -
yum install doxygen

Caso queira instalar o Doxywizard (um insterface gráfica do Doxygen), realize os seguintes o comando abaixo, ainda como root:

yum install doxygen-doxywizard

Configurando o Doxygen

Você poderá configurar o Doxygen de forma que ele possa extrair dos códigos o que for mais conveniente. Esta etapa poderá ser feita de duas formas:

• 1) Poderá criar o arquivo de configuraçÃo pela linha de comando e depois alterá-lo com o seu editor favorito:

doxygen -g my_file.cfg
vim my_file.cfg

• 2) Poderá utilizar a interface gráfica doxywizard a qual cria/carrega um arquivo de configuração :

Executando o Doxygen

Você poderá executar o Doxygen também de duas formas:

• 1) Pela linha de comando:

doxygen path

Onde path especifa o caminho até o diretório que contém os seus fontes.

• 2) Ou poderá utilizar a interface gráfica doxywizard:

Saída do Doxygen

O Doxygen gera tantas saídas quanto for especificado (latex, html, doc, ...). Todos este arquivos estão localizados no diretório que você especificou como saída durante a fase de configuração.

Doxygen e o SCAE

Ao escrever comentário que precede uma função, deveremos seguir o exemplo abaixo e adotá-lo como padrão:

/**
\details This function ....
\author Fulano Ciclano Beltrano
\date 15/02/2008   
\param a The length ...
\param b The width ...
\param b The height ... 
\return vol The voulem ...
\note Be sure that:
- length > 0;
- width > 0;
- height > 0.
\sa calculate_area, calculate_size
*/

void calculate (int a, int b, int c)