Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
terralib:padraodocumentacao [2008/04/02 12:10] 150.163.3.123 |
terralib:padraodocumentacao [2008/04/02 15:45] (current) laercio |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Documentação DOxygen ====== | ====== 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: | + | 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: |
| <code cpp> | <code cpp> | ||
| + | //! Brief description. | ||
| /*! | /*! | ||
| - | ... descritption ... | + | A more elaborate description. |
| + | |||
| + | \tags | ||
| */ | */ | ||
| </code> | </code> | ||
| + | Algumas regras: | ||
| + | * toda documentação deve ser escrita imediatamente antes das definições dos tipos, evitando assim o uso de tags estruturais (\class, \struct, \enum, \def, etc). Para maiores detalhes ver (http://www.stack.nl/~dimitri/doxygen/docblocks.html). | ||
| + | * toda documentação deve ter no mínimo a descrição breve. A documentação detalhada e uso de tags, em alguns casos, não é necessária. \\ Exemplo: | ||
| + | |||
| + | <code cpp> | ||
| + | ... | ||
| + | //! Empty contructor | ||
| + | TePolygon(void); | ||
| + | ... | ||
| + | </code> | ||
| + | |||
| + | |||
| + | |||
| Line 21: | Line 37: | ||
| More detailed description. | More detailed description. | ||
| - | \author (?) | + | \author |
| + | \version | ||
| \sa | \sa | ||
| */ | */ | ||
| Line 29: | Line 46: | ||
| - | ===== Macro, Namespace, Constante ===== | ||
| - | * A descrição breve é obrigatória e a descrição detalhada é opcional. \\ Exemplo: | + | |
| - | <code cpp> | + | |
| - | //! A brief description. | + | |
| - | /*! | + | |
| - | A more elaborate description. | + | |
| - | */ | + | |
| - | </code> | + | |
| Line 50: | Line 66: | ||
| //! A brief description of class or struct. | //! A brief description of class or struct. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | A more elaborate description of class or struct. |
| - | \sa other definitions related to the class or struct | + | |
| + | \author (?) | ||
| + | \sa other definitions related to the class or struct | ||
| */ | */ | ||
| </code> | </code> | ||
| Line 61: | Line 79: | ||
| //! A brief description. | //! A brief description. | ||
| /*! | /*! | ||
| - | A more elaborate description of class or struct. | + | A more elaborate description of class or struct. |
| - | \param name description | + | |
| - | \return description | + | \param name description |
| + | \return description | ||
| */ | */ | ||
| </code> | </code> | ||
| === Membro === | === Membro === | ||
| - | * A descrição do membro deve vir depois de sua definição. | + | * A descrição breve ou detalhada do membro deve vir acima de sua definição. |
| <code cpp> | <code cpp> | ||
| - | int member01_; //!< Brief description after the member | + | |
| - | int member02_; //!< Brief description after the member | + | //! Brief description |
| + | int firstMember_; | ||
| + | |||
| + | //! Brief description | ||
| + | int secondMember_; | ||
| + | |||
| + | //! Brief description | ||
| + | /*! | ||
| + | Detailed description | ||
| + | */ | ||
| + | int thirdMember_; | ||
| </code> | </code> | ||
| + | |||
| + | |||
| + | |||
| + | ===== Enumeração ===== | ||
| + | |||
| + | * A descrição breve do tipo e de seus valores são obrigatórias. A descrição detalhada é opcional. \\ Exemplo: | ||
| + | <code cpp> | ||
| + | //! 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. | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ===== Macro, Namespace, Constante ===== | ||
| + | |||
| + | * A descrição breve é obrigatória e a descrição detalhada é opcional. \\ Exemplo: | ||
| + | <code cpp> | ||
| + | //! A brief description. | ||
| + | /*! | ||
| + | A more elaborate description. | ||
| + | */ | ||
| + | </code> | ||
