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:
-
Oct 30, 2009, 6:35:52 PM (16 years ago)
- Author:
-
adv
- Comment:
-
Actaulización bash-doxygen
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v12
|
v13
|
|
39 | 39 | |
40 | 40 | [[br]] |
41 | | Las funciones bash deben estar en el siguiente formato: |
| 41 | Las funciones bash deben estar OBLIGATORIAMENTE en el siguiente formato: |
42 | 42 | {{{ |
43 | 43 | function ogBoot () |
… |
… |
|
46 | 46 | } |
47 | 47 | }}} |
| 48 | |
| 49 | En caso contrarió no generará bien las dependencias. |
| 50 | |
48 | 51 | = tag de doxygen = |
49 | 52 | |
50 | 53 | |
51 | 54 | = Generar la Documentación = |
52 | | La libreria EACInstall.lib tiene la función GenerateDoxygenForBash(str_pathFuentes, str_pathdestino). La cual incluye los parametros especiales para documentar bash. |
| 55 | trunk/install/ogGenerateDoc.sh |
| 56 | Parametro 1 $str_pathFuentes |
| 57 | Parametro 2 $str_pathdestino. |
| 58 | |
53 | 59 | |
54 | 60 | |
… |
… |
|
57 | 63 | == Ejemplo de documentación == |
58 | 64 | {{{ |
59 | | function DoxyFileBashEAC () { |
60 | | #/** @function DoxyFileBashEAC: @brief Genera Documentación Doxygen . |
| 65 | function ejemplo () |
| 66 | { |
| 67 | #/** @function FunExample: @brief ejemplo de codigo bash para doxygen |
61 | 68 | #@param $1 str_pathOrgien |
62 | 69 | #@param $2 str_pathDestino |
63 | | #@param ejemplo DoxyFileBashEAC /var/EAC/admin/librerias /var/EAC/documentcion/ |
64 | | #@return genera la documentacion en el path indicado como paratetro 2. |
| 70 | #@param ejemplo FunExample /var/EAC/admin/librerias /var/EAC/documentcion/ |
| 71 | #@return genera la documentacion en el path indicado como parametro 2. |
65 | 72 | #@warning Salidas de errores no determinada |
66 | 73 | #@attention |
… |
… |
|
68 | 75 | #@note Notas sin especificar |
69 | 76 | #*/ |
70 | | |
| 77 | echo "La línea siguientes es un comentario solo para bash" |
| 78 | # comentario solo para bash |
| 79 | echo "La linea siguiente es un comentario tanto para bash como para doxygen" |
| 80 | # /// FIXME: falta controlar los errores |
| 81 | echo "Ojo si se inserta un /*, , debemos terminar la instruccion con " # */ |
| 82 | cp /pruebas/* /destino # */ |
| 83 | echo "Para insertar un comentario para que también lo interprete doxygen" |
| 84 | # /// FIXME: falta controlar los errores |
| 85 | } |
71 | 86 | }}} |
72 | 87 | |