Changes between Version 12 and Version 13 of docDoxygen


Ignore:
Timestamp:
Oct 30, 2009, 7:35:52 PM (15 years ago)
Author:
adv
Comment:

Actaulización bash-doxygen

Legend:

Unmodified
Added
Removed
Modified
  • docDoxygen

    v12 v13  
    3939
    4040[[br]]
    41 Las funciones bash deben estar en el siguiente formato:
     41Las funciones bash deben estar OBLIGATORIAMENTE en el siguiente formato:
    4242{{{
    4343function ogBoot ()
     
    4646}
    4747}}}
     48
     49En caso contrarió no generará bien las dependencias.
     50
    4851= tag de doxygen =
    4952
    5053
    5154= 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.
     55trunk/install/ogGenerateDoc.sh
     56Parametro 1        $str_pathFuentes
     57Parametro 2        $str_pathdestino.
     58
    5359
    5460
     
    5763== Ejemplo de documentación ==
    5864{{{
    59 function DoxyFileBashEAC () {
    60 #/**  @function DoxyFileBashEAC: @brief Genera Documentación Doxygen .
     65function ejemplo ()
     66{
     67#/**  @function FunExample: @brief ejemplo de codigo bash para doxygen
    6168#@param $1 str_pathOrgien
    6269#@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.
    6572#@warning  Salidas de errores no determinada
    6673#@attention
     
    6875#@note    Notas sin especificar
    6976#*/
    70 
     77echo "La línea siguientes es un comentario solo para bash"
     78# comentario solo para bash
     79echo "La linea siguiente es un comentario tanto para bash como para doxygen"
     80# /// FIXME: falta controlar los errores
     81echo "Ojo si se inserta un /*, , debemos terminar la instruccion con " # */
     82cp /pruebas/*  /destino   # */
     83echo "Para insertar un comentario para que también lo interprete doxygen"
     84# /// FIXME: falta controlar los errores
     85}
    7186}}}
    7287