You are on page 1of 23

Doxygen Documentando seu Código-fonte

Kleber de Oliveira Andrade
pdjkleber@gmail.com pdjkleber@sc.usp.br

Laboratório de Robótica Móvel - LabRoM Grupo de Mecatrônica - http://www.mecatronica.eesc.usp.br

Escola de Engenharia de São Carlos – EESC/USP Setembro de 2010

Sumário
• Introdução
• Padrões de documentação usando o Doxygen • Configurando o Doxygen • Resultados
2010 © Kleber de Oliveira Andrade 2

Sumário • Introdução • Padrões de documentação usando o Doxygen • Configurando o Doxygen • Resultados 2010 © Kleber de Oliveira Andrade 3 .

Por que documentar ? 1 2 3 • Facilitar a reutilização e manutenção • Disponibilizar documentação profissional • Contribuir com o conhecimento 2010 © Kleber de Oliveira Andrade 4 .

O que é Doxygen? É um sistema de documentação de código-fonte Linguagens •C • C++ • C# • Object-C • Python • PHP • Java • IDL •D Plataformas • GNU/Linux (Unix) • Mac OS X • Windows Saídas • HTML • Latex • RTF • PostScript • PDF • XML • CHM • Unix man pages 2010 © Kleber de Oliveira Andrade 5 .

Fluxo de informação do Doxygen 2010 © Kleber de Oliveira Andrade 6 .

Sumário • Introdução • Padrões de documentação usando o Doxygen • Configurando o Doxygen • Resultados 2010 © Kleber de Oliveira Andrade 7 .

}. pode ter várias linhas dentro deste bloco \param valorFloat Descrição do parametro float \return Descrição do valor de retorno */ int Conveter( float valorFloat ). double valorDouble. */ class Teste { //! Documentação antes do membro int valorInt. /*!< Documentação depois do membro */ /** Descrição simples da função até o ponto final Descrição detalhada da função. * Esta pode ter várias linhas.Primeiro Exemplo /// Descrição simples da classe (uma linha) /** * Descrição detalhada da classe. 2010 © Kleber de Oliveira Andrade 8 . * Quantas linhas você realmente quiser.

. */ ///< /**< .. */ /// /** . */ Documentação simples de uma linha (antes) Documentação de múltiplas linhas (antes) Documentação simples de uma linha (depois) Documentação de múltiplas linhas (depois) Mesmo comportamento de //! Mesmo comportamento de /*! ... */ para manter compatibilidade com estilo de documentação usada em C# 2010 © Kleber de Oliveira Andrade 9 .. */ //!< /*!< ... */ Prefere-se o uso de /// e /* .. */ Mesmo comportamento de //!< Mesmo comportamento de /*!< ..Padrões comuns //! /*! ......

troca-se \ por @ 2010 © Kleber de Oliveira Andrade 10 .Blocos de documentação auxiliar \brief \param \return \sa \warning Uma linha simples de documentação Parâmetro de uma função Valor de retorno de uma função Documentação auxiliar aconselhada (see also) Documentação de avisos ao usuário Para usar em Java.

Estilos especiais \class \struct \union \enum \fn \def \file \var \namespace \package \interface Classes Estruturas Uniões Enumeradores Funções #define Arquivos Variáveis Namespaces Pacotes Interface 2010 © Kleber de Oliveira Andrade 11 .

sub sub item 2 * . * The dot above ends the sub sub item list. * More text for the first sub item * .sub item 1 * .list item 2 *.sub item 3 * . */ 2010 © Kleber de Oliveira Andrade 12 . * * More text in a new paragraph.sub item 2 * .list item 1 * . * More text for the first list item * .Exemplo de Listas /** * Text before the list * . * The dot above ends the first sub item.sub sub item 1 * . * More text in the same paragraph.

Outros • Grupos – Agrupamento de entidades para melhorar a organização do documento • Equações – Inclusão de equações junto à documentação • Diagramas – Geração de grafos e diagramas UML de acordo com o relacionamento das entidades no código 2010 © Kleber de Oliveira Andrade 13 .

Sumário • Introdução • Padrões de documentação usando o Doxygen • Configurando o Doxygen • Resultados 2010 © Kleber de Oliveira Andrade 14 .

Doxygen GUI (Interface) 2010 © Kleber de Oliveira Andrade 15 .

Configurações básicas 2010 © Kleber de Oliveira Andrade 16 .

Configurações básicas 2010 © Kleber de Oliveira Andrade 17 .

Configurações básicas 2010 © Kleber de Oliveira Andrade 18 .

Configurações básicas 2010 © Kleber de Oliveira Andrade 19 .

Configurações avançadas 2010 © Kleber de Oliveira Andrade 20 .

Sumário • Introdução • Padrões de documentação usando o Doxygen • Configurando o Doxygen • Resultados 2010 © Kleber de Oliveira Andrade 21 .

Resultado Final 2010 © Kleber de Oliveira Andrade 22 .

com pdjkleber@sc.http://www.LabRoM Grupo de Mecatrônica .br Escola de Engenharia de São Carlos – EESC/USP Setembro de 2010 23 .eesc.usp.br Laboratório de Robótica Móvel .usp.Obrigado pela Atenção ! Kleber de Oliveira Andrade pdjkleber@gmail.mecatronica.