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:
//! Brief description. /*! A more elaborate description. \tags */
Algumas regras:
... //! Empty contructor TePolygon(void); ...
/*!
\file file name
\brief brief description about the file.
Brief description continued.
More detailed description.
\author
\version
\sa
*/
//! A brief description of class or struct. /*! A more elaborate description of class or struct. \author (?) \sa other definitions related to the class or struct */
//! A brief description. /*! A more elaborate description of class or struct. \param name description \return description */
//! Brief description int firstMember_; //! Brief description int secondMember_; //! Brief description /*! Detailed description */ int thirdMember_;
//! Brief description about enum /*! A more elaborate description. \sa ... */ enum TEnum { TVal1, //!< brief description about enum value TVal1. TVal2, //!< brief description about enum value TVal2. TVal3 //!< brief description about enum value TVal3. }
//! A brief description. /*! A more elaborate description. */