close
Warning:
Failed to sync with repository "ogBrowser-Git": (1366, "Incorrect string value: '\\xF0\\x9F\\x93\\xA6 I...' for column 'message' at row 1"); repository information may be out of date. Look in the Trac log for more information including mitigation strategies.
- Timestamp:
-
Dec 15, 2009, 11:28:53 AM (17 years ago)
- Author:
-
ramon
- Comment:
-
Plantilla para documentar funciones
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v14
|
v15
|
|
| 18 | 18 | |
| 19 | 19 | || comentario normal C || TAG para ser procesado por doxygen en C || |
| 20 | | || /* [[BR]] lineas comentadas [[BR]] */ || //* [[BR]] Tag para doxigen [[BR]] */ || |
| | 20 | || /* [[BR]] lineas comentadas [[BR]] */ || /** [[BR]] Tag para doxigen [[BR]] */ || |
| 21 | 21 | || // comentario de linea || /// comentario de linea para doxigen || |
| 22 | 22 | |
| … |
… |
|
| 24 | 24 | |
| 25 | 25 | || comentario normal bash || TAG para ser procesado por doxygen en bash || |
| 26 | | || # comentario de bloque [[BR]] # comentario de bloque || #//* [[BR]] # Tag 1 para doxigen [[BR]] # Tag 2 para doxigen [[BR]] #*/ || |
| | 26 | || # comentario de bloque [[BR]] # comentario de bloque || #/** [[BR]] # Tag 1 para doxigen [[BR]] # Tag 2 para doxigen [[BR]] #*/ || |
| 27 | 27 | || # comentario de linea || # /// tag para doxigen || |
| 28 | 28 | |
| … |
… |
|
| 55 | 55 | En caso contrarió no generará bien las dependencias. |
| 56 | 56 | |
| 57 | | = tag de doxygen = |
| | 57 | == Plantilla para documentar funciones == |
| | 58 | |
| | 59 | Se ha acordado utilizar la siguiente plantilla para documentar con Doxygen las funciones BASH del motor de clonación. |
| | 60 | |
| | 61 | {{{ |
| | 62 | #/** |
| | 63 | # nombreFunción tipo_param ... (formato de la función). |
| | 64 | #@brief Descripción breve de la función. |
| | 65 | #@param tipo_param Descripción del parámetro (una línea por cada parámetro). |
| | 66 | #@return tipo_valor - Valor devuelto por la función. |
| | 67 | #@exception TipoError Descripción del error (1 línea por cada error). |
| | 68 | #@note Nota sobre la función (opcional). |
| | 69 | #@warning Aviso importante sobre la función (opcional). |
| | 70 | #@todo Trabajo pendiente de realizar (opcional). |
| | 71 | #@version versión - Descripción de la versión o los cambios. |
| | 72 | #@author Autor, Universidad (1 línea por cada autor). |
| | 73 | #@date Fecha (año-mes-día) |
| | 74 | #*/ ## |
| | 75 | function nombreFunción () |
| | 76 | { |
| | 77 | # Comentario normal del código. |
| | 78 | ... |
| | 79 | #/// Comentario especial para incluir en la documentación Doxygen. |
| | 80 | ... |
| | 81 | } |
| | 82 | }}} |
| | 83 | |
| | 84 | Debe documentarse un histórico completo de cambios de cada función, incluyendo tantas tripletas de etiquetas {{{@version}}}, {{{@author}}} y {{{@date}}} como sean necesarias. |
| | 85 | |
| | 86 | 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++. |
| 58 | 87 | |
| 59 | 88 | |
| 60 | 89 | = Generar la Documentación = |
| 61 | | trunk/install/ogGenerateDoc.sh |
| 62 | | Parametro 1 $str_pathFuentes |
| 63 | | Parametro 2 $str_pathdestino. |
| 64 | 90 | |
| 65 | | { |
| | 91 | Ejecutar el script {{{trunk/install/ogGenerateDoc.sh}}} con el siguiente formato: |
| | 92 | * Parámetro 1: {{{str_pathFuentes}}} |
| | 93 | * Parámetro 2: {{{str_pathdestino}}} |
| | 94 | |
| | 95 | Ejemplos de ejecución: |
| | 96 | {{{ |
| 66 | 97 | ogGenerateDoc.sh trunk/client/engine/ /opt/opengnsys/doc/engine |
| 67 | 98 | ogGenerateDoc.sh trunk/administrator/web/ /opt/opengnsys/doc/administrator_web |
| 68 | | } |
| | 99 | }}} |
| 69 | 100 | |
| 70 | 101 | |
| … |
… |
|
| 99 | 130 | Observaciones de la imagen: |
| 100 | 131 | |
| 101 | | |