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:
-
Nov 22, 2009, 12:26:40 PM (17 years ago)
- Author:
-
adv
- Comment:
-
Más normas para documentar doxygen código bash
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v13
|
v14
|
|
| 27 | 27 | || # comentario de linea || # /// tag para doxigen || |
| 28 | 28 | |
| 29 | | == Modificaciones especiales para el lenguaje bash == |
| | 29 | == Modificaciones especiales para el lenguaje bash cuan usamos el /* == |
| 30 | 30 | 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. |
| 31 | 31 | 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. |
| 37 | 37 | cp origen/* /destino # */ Requisito para Doxygen |
| | 38 | }}} |
| | 39 | |
| | 40 | otro ejemplo, uso del /* en código bash más complejo: |
| | 41 | {{{ |
| | 42 | # nota: en la siguiente linea doxygen encuentra comentario /* así que debemos insertar # */ . Pero además debemos cerrar corchetes, comas .... |
| | 43 | FILEPATH="${FILEPATH}/$(ls -A | grep -i -m1 "^${FILE%%/*}$")" || return $? # */}$")" (necesario Doxygen) |
| 38 | 44 | }}} |
| 39 | 45 | |
| … |
… |
|
| 57 | 63 | Parametro 2 $str_pathdestino. |
| 58 | 64 | |
| 59 | | |
| | 65 | { |
| | 66 | ogGenerateDoc.sh trunk/client/engine/ /opt/opengnsys/doc/engine |
| | 67 | ogGenerateDoc.sh trunk/administrator/web/ /opt/opengnsys/doc/administrator_web |
| | 68 | } |
| 60 | 69 | |
| 61 | 70 | |