Changes between Version 14 and Version 15 of docDoxygen

Timestamp:

Dec 15, 2009, 11:28:53 AM (15 years ago)

Author:

ramon

Comment:

Plantilla para documentar funciones

docDoxygen

@@ -18 +18 @@
 
 || comentario normal C  || TAG para ser procesado por doxygen en C ||
-|| /* [[BR]] lineas comentadas [[BR]]  */      || //* [[BR]] Tag para doxigen  [[BR]] */ ||   
+|| /* [[BR]] lineas comentadas [[BR]]  */      || /** [[BR]] Tag para doxigen  [[BR]] */ ||   
 || //  comentario de linea   ||  /// comentario de linea para doxigen ||
 
@@ -24 +24 @@
 
 || comentario normal bash || TAG para ser procesado por doxygen en bash ||
-|| # comentario de bloque [[BR]] # comentario de bloque      || #//* [[BR]] # Tag 1 para doxigen  [[BR]] # Tag 2 para doxigen  [[BR]] #*/ ||   
+|| # comentario de bloque [[BR]] # comentario de bloque      || #/** [[BR]] # Tag 1 para doxigen  [[BR]] # Tag 2 para doxigen  [[BR]] #*/ ||   
 || # comentario de linea   || # /// tag para doxigen ||
 
@@ -55 +55 @@
 En caso contrarió no generará bien las dependencias.
 
-= tag de doxygen =
+== Plantilla para documentar funciones ==
+
+Se ha acordado utilizar la siguiente plantilla para documentar con Doxygen las funciones BASH del motor de clonación.
+
+{{{
+#/**
+#         nombreFunción tipo_param ...                (formato de la función).
+#@brief   Descripción breve de la función.
+#@param   tipo_param   Descripción del parámetro      (una línea por cada parámetro).
+#@return  tipo_valor - Valor devuelto por la función.
+#@exception TipoError  Descripción del error          (1 línea por cada error).
+#@note    Nota sobre la función                       (opcional).
+#@warning Aviso importante sobre la función           (opcional).
+#@todo    Trabajo pendiente de realizar               (opcional).
+#@version versión - Descripción de la versión o los cambios.
+#@author  Autor, Universidad                         (1 línea por cada autor).
+#@date    Fecha                                      (año-mes-día)
+#*/ ##
+function nombreFunción ()
+{
+# Comentario normal del código.
+...
+#/// Comentario especial para incluir en la documentación Doxygen.
+...
+}
+}}}
+
+Debe documentarse un histórico completo de cambios de cada función, incluyendo tantas tripletas de etiquetas {{{@version}}}, {{{@author}}} y {{{@date}}} como sean necesarias.
+
+La línea final del comentario general ({{{#*/ ##}}}) es necesaria para que Doxygen reconozca las dependencias de la función, puesto que la sintaxis de BASH se asemeja más a la de Python que a la de C/C++.
 
 
 = Generar la Documentación =
-trunk/install/ogGenerateDoc.sh 
-Parametro 1        $str_pathFuentes 
-Parametro 2        $str_pathdestino. 
 
-{
+Ejecutar el script {{{trunk/install/ogGenerateDoc.sh}}} con el siguiente formato:
+ * Parámetro 1:     {{{str_pathFuentes}}}
+ * Parámetro 2:     {{{str_pathdestino}}}
+
+Ejemplos de ejecución:
+{{{
 ogGenerateDoc.sh trunk/client/engine/ /opt/opengnsys/doc/engine
 ogGenerateDoc.sh trunk/administrator/web/ /opt/opengnsys/doc/administrator_web
-}
+}}}
 
 
@@ -99 +130 @@
 Observaciones de la imagen:
 
-