Diferenças

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

--- terralib:padraodocumentacao [2008/04/02 15:31] – 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 102: / Linha 105: @@
-===== Macro, Namespace, Constante  =====
-    * A descrição breve é obrigatória e a descrição detalhada é opcional. \\ Exemplo:
+===== Enumeração  =====
+    * A descrição breve do tipo e de seus valores são obrigatórias. A descrição detalhada é opcional. \\ Exemplo:
 <code cpp>
-//!  A brief description.
+//! Brief description about enum
 /*!
-     A more elaborate description.
+  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>