Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- terralib:padraodocumentacao [2008/04/02 15:30] – 150.163.3.123
+++ terralib:padraodocumentacao [2008/04/02 18:45] (atual) – laercio
@@ Linha 21: / Linha 21: @@
 ...
 </code>
@@ Linha 35: / Linha 37: @@
    More detailed description.
-  \author (?)
+  \author
-  \sa  (?)
+  \version
+  \sa
 */
 </code>
@@ Linha 74: / Linha 79: @@
 //!  A brief description.
 /*!
-   A more elaborate description of class or struct.
+  A more elaborate description of class or struct.
-   \param  name description
+  \param  name description
-   \return description
+  \return description
 */
 </code>
@@ Linha 94: / Linha 99: @@
 //! Brief description
 /*!
-   Detailed description
+  Detailed description
 */
 int thirdMember_;
 </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  =====