Documentação DOxygen

O objetivo dessa parte é padronizar os comentários utilizando tags do DOxygen (http://www.stack.nl/~dimitri/doxygen), a fim de documentar o código de maneira padronizada e automática. O estilo adotado será o Qt (http://www.stack.nl/~dimitri/doxygen/docblocks.html) sem os *'s intermediários. Exemplo:

/*!
 ... descritption ...
*/

• Devem seguir o padrão abaixo e ter no mínimo as tags \file, \brief e \author:

/*! 
  \file   file name
  \brief  brief description about the file.
          Brief description continued.
 
   More detailed description.
 
  \author (?)
  \sa
*/

• No caso de classes e estruturas é obrigatório colocar as descrições breve e detalhada. A tag \sa é opcional.
  Exemplo:

//!  A brief description of class or struct. 
/*!
     A more elaborate description of class or struct.
     \sa  other definitions related to the class or struct  
*/

• Os métodos devem conter no mínimo uma descrição breve, a descrição de todos os seus parâmetros (tag \param) e do seu valor de retorno (tag \return). A descrição detalhada é opcional.

//!  A brief description. 
/*!
     A more elaborate description of class or struct.
     \param  name description
     \return description
*/

• A descrição do membro deve vir depois de sua definição.

int member01_;   //!< Brief description after the member
int member02_;   //!< Brief description after the member

• A descrição breve é obrigatória e a descrição detalhada é opcional.
  Exemplo:

//!  A brief description. 
/*!
     A more elaborate description.
*/