Changes between Version 13 and Version 14 of docDoxygen

Timestamp:

Nov 22, 2009, 1:26:40 PM (14 years ago)

Author:

adv

Comment:

Más normas para documentar doxygen código bash

docDoxygen

@@ -27 +27 @@
 || # comentario de linea   || # /// tag para doxigen ||
 
-== Modificaciones especiales para el lenguaje bash ==
+== Modificaciones especiales para el lenguaje bash cuan usamos el /* ==
 Doxygen está preparado para documentar C, y no bash. En muchas ocasiones utilizamos en bash, /* para muchas operaciones, pero doxygen lo va a interpretar como comentario del fuente y si no encuentra un */ (fin comentario) tendremos errores. 
 Cuando estemos programando y tenemos la intención de autodocumentar con Doxygen, debemos de tener en cuenta:
@@ -36 +36 @@
 # ya que la instrucción cp utiliza los caracteres que usa C para iniciar comentarios.
 cp origen/* /destino   # */ Requisito para Doxygen 
+}}}
+
+otro ejemplo, uso del /* en código bash más complejo:
+{{{
+# nota: en la siguiente linea doxygen encuentra comentario /* así que debemos insertar # */ . Pero además debemos cerrar corchetes, comas ....
+ FILEPATH="${FILEPATH}/$(ls -A | grep -i -m1 "^${FILE%%/*}$")" || return $?   # */}$")" (necesario Doxygen)
 }}}
 
@@ -57 +63 @@
 Parametro 2        $str_pathdestino. 
 
-
+{
+ogGenerateDoc.sh trunk/client/engine/ /opt/opengnsys/doc/engine
+ogGenerateDoc.sh trunk/administrator/web/ /opt/opengnsys/doc/administrator_web
+}