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:28] 150.163.3.123 |
terralib:padraodocumentacao [2008/04/02 15:45] (current) laercio |
||
---|---|---|---|
Line 21: | Line 21: | ||
... | ... | ||
</code> | </code> | ||
+ | |||
+ | |||
+ | |||
Line 34: | Line 37: | ||
More detailed description. | More detailed description. | ||
- | \author (?) | + | \author |
- | \sa (?) | + | \version |
+ | \sa | ||
*/ | */ | ||
</code> | </code> | ||
+ | |||
+ | |||
+ | |||
+ | |||
Line 59: | Line 67: | ||
/*! | /*! | ||
A more elaborate description of class or struct. | A more elaborate description of class or struct. | ||
+ | |||
\author (?) | \author (?) | ||
\sa other definitions related to the class or struct | \sa other definitions related to the class or struct | ||
Line 70: | 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> | ||
Line 81: | Line 91: | ||
<code cpp> | <code cpp> | ||
- | //! Brief description after the member | + | //! Brief description |
int firstMember_; | int firstMember_; | ||
- | //! Brief description after the member | + | //! Brief description |
int secondMember_; | int secondMember_; | ||
- | //! Brief description after the member | + | //! Brief description |
/*! | /*! | ||
- | Detailed description after the member | + | Detailed description |
*/ | */ | ||
int thirdMember_; | 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 ===== | ===== Macro, Namespace, Constante ===== |