Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
terralib:padraodocumentacao [2008/04/02 12:31]
150.163.3.123
terralib:padraodocumentacao [2008/04/02 15:45] (current)
laercio
Line 21: Line 21:
 ... ...
 </​code>​ </​code>​
 +
 +
  
  
Line 35: Line 37:
    More detailed description.    More detailed description.
  
-  \author ​(?) +  \author 
-  \sa  (?)+  \version 
 +  \sa
 */ */
 </​code>  ​ </​code>  ​
    
 +
  
  
Line 101: Line 105:
  
  
 +
 +
 +===== 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 ​ =====

Navigation