charla_doxygen_20031212/charla.doxy

   1 /** @mainpage
   2
   3 @section intro Introducción.
   4         @subsection block  Bloque de documentación.
   5                 @if MACHETE
   6                         Tipos de bloques:
   7                         @verbatim
   8                         / **
   9                         / *!
  10                         //!
  11                         ///
  12                         @endverbatim
  13                 @endif
  14         @subsection compat Compatibilidad con JavaDoc y QT.
  15         @subsection comman Comandos especiales.
  16                 @if MACHETE
  17                         Todo lo que empieza con \\ o \@.
  18                         - param
  19                         - return
  20                         - brief
  21                 @endif
  22         @subsection brief  Descripción Breve y Detallada.
  23                 @if MACHETE
  24                         Para la descripción breve hay que poner un \@brief
  25                         a menos que se use JAVADOC_AUTOBRIEF.
  26                 @endif
  27         @subsection inline Documentación en línea.
  28                 @if MACHETE
  29                         Documentacion detallada:
  30                         @verbatim
  31                         / **<
  32                         / *!<
  33                         @endverbatim
  34                         Documentacion breve:
  35                         @verbatim
  36                         //!<
  37                         ///<
  38                         @endverbatim
  39                         Tambien puede ser usada como detallada si tiene 2
  40                         renglones.
  41                 @endif
  42         @subsection ofline Documentación fuera de línea.
  43                 @if MACHETE
  44                         Se puede documentar fuera de línea estos elementos:
  45                         @verbatim
  46                         @struct to document a C-struct.
  47                         @union to document a union.
  48                         @enum to document an enumeration type.
  49                         @fn to document a function.
  50                         @var to document a variable or typedef or enum value.
  51                         @def to document a #define.
  52                         @file to document a file.
  53                         @namespace to document a namespace.
  54                         @package to document a Java package.
  55                         @interface to document an IDL interface.
  56                         @endverbatim
  57                 @endif
  58         @subsection config Creación y opciones del archivo de configuración.
  59                 @if MACHETE
  60                         @verbatim doxygen -g <config-file> @endverbatim
  61                         Mostrar doxywizard.
  62                 @endif
  63         @subsection format Formatos de salida.
  64                 @if MACHETE
  65                         - HTML
  66                         - LaTeX -> PDF
  67                         - RTF
  68                         - Man
  69                         - PerlMod
  70                         - CHM (o algo asi)
  71                 @endif
  72         @subsection lang Lenguajes soportados.
  73                 @if MACHETE
  74                         Muchos, el español está :)
  75                 @endif
  76
  77 @section mejor Mejorando la calidad de las descripciones.
  78         @subsection refauto Links y referencias cruzadas automáticos.
  79                 @if MACHETE
  80                         - Detecta URLs y e-mails.
  81                         - Detecta classes, funciones, variables y archivos.
  82                         Formas de especificar scope:
  83                         @verbatim
  84                         funcion(args)
  85                         funcion()
  86                         ::funcion
  87                         scope::funcion(args)
  88                         scope::funcion()
  89                         scope::funcion
  90                         @endverbatim
  91                         Donde <tt>scope</tt> pueden ser namespaces y clases
  92                         anidadas. Se puede usar "#" en vez de "::" para
  93                         compatibilidad con JavaDoc.
  94                         @note Mencionar el tema del scope (hay que poner
  95                         ::simbolo para referirse a un simbolo global).
  96
  97                         Para funciones no sobrecargadas puede omitirse los
  98                         argumentos.
  99
 100                         Expande typedefs.
 101                 @endif
 102         @subsection refman Referencias cruzadas manuales.
 103                 @if MACHETE
 104                         @verbatim \\ref nombre ["texto"] @endverbatim
 105                         Si no se especifica el "texto", se pone el titulo de la
 106                         seccion. Particularmente util para usar con paginas y
 107                         secciones propias y para darle nombre a los links a
 108                         clases y funciones.
 109                 @endif
 110         @subsection href Hipervínculos (sólo salida HTML).
 111                 @if MACHETE
 112                         Aprovechar para nombrar otros comandos HTML.
 113                 @endif
 114         @subsection code Incluir código de ejemplo.
 115                 @if MACHETE
 116                         Nombrar \@code y \@example.
 117                 @endif
 118         @subsection listas Listas (con bullets o numeradas).
 119                 @if MACHETE
 120                         Nombrar:
 121                         - Listas comunes con bullets con '-'.
 122                         - Listas comunes numeradas con '-#'.
 123                         Pueden ser anidadas identando, para terminar. Para
 124                         terminar una lista dejar una linea vacia o que tenga
 125                         solo un punto:
 126                         @verbatim
 127                         - 1
 128                                 - 1.1
 129                                 - 1.2
 130                                 .
 131                                 Seguimos escribiendo en el item '1'.
 132                         - 2.
 133                           Mas texto en el 2
 134                         .
 135                         Termina la lista y sigue el texto en el mismo párrafo.
 136                         @endverbatim
 137                         Resultado:
 138                         - 1
 139                                 - 1.1
 140                                 - 1.2
 141                                 .
 142                                 Seguimos escribiendo en el item '1'.
 143                         - 2.
 144                           Mas texto en el 2
 145                         .
 146                         Termina la lista y sigue el texto en el mismo párrafo.
 147                         Nombrar listas en formato HTML.
 148                 @endif
 149         @subsection tablas Tablas.
 150                 @if MACHETE
 151                         Nombrar tablas en HTML.
 152                 @endif
 153         @subsection math Fórmulas matemáticas.
 154                 @if MACHETE
 155                         Hay formulas en embebidas en el texto:
 156                         @verbatim
 157                         La distancia entre \@f$ (x_1, y_1) \@f$ y
 158                         \@f$ (x_2, y_2) \@f$ es
 159                         \@f$ \\sqrt{ (x_2 - x_1)^2 + (y_2 - y_1)^2 } \@f$
 160                         @endverbatim
 161                         Resultado:
 162                         La distancia entre @f$ (x_1, y_1) @f$ y
 163                         @f$ (x_2, y_2) @f$ es
 164                         @f$ \sqrt{ (x_2 - x_1)^2 + (y_2 - y_1)^2 } @f$
 165                         Y formulas en su propio renglón:
 166                         @verbatim
 167                         \@f[ \\sqrt{ (x_2 - x_1)^2 + (y_2 - y_1)^2 } \@f]
 168                         @endverbatim
 169                         Resultado:
 170                         @f[ \sqrt{ (x_2 - x_1)^2 + (y_2 - y_1)^2 } @f]
 171
 172                         @note Ver como engancharlo con lo que explique Diego.
 173                 @endif
 174         @subsection images Agregar imágenes.
 175                 @if MACHETE
 176                         @verbatim
 177                         \@image format file ["caption"] [sizeindication=size]
 178                         @endverbatim
 179                         Ejemplo:
 180                         @verbatim
 181                         \@image html  diagrama.jpg
 182                         \@image latex diagrama.eps "Diagrama de lala" width=10cm
 183                         @endverbatim
 184                         @note Las imagenes deben estar en el IMAGE_PATH.
 185                 @endif
 186
 187 @section avanzado Características avanzadas.
 188         @subsection pagina Páginas relacionadas.
 189                 @if MACHETE
 190                         Nombrar \c bug, \c todo, \c example, \c deprecated.
 191                 @endif
 192         @subsection pagpro Páginas propias.
 193                 @if MACHETE
 194                         Nombrar \c page, \c section, \c subsection, etc.
 195                 @endif
 196         @subsection salidas Contenido selectivo.
 197                 @if MACHETE
 198                         Nombrar \c htmlonly, \c latexonly, \c if, \c internal,
 199                         etc.
 200                 @endif
 201         @subsection pulir Pulir los resultados.
 202                 @if MACHETE
 203                         Mostrar un refman.tex y retocarlo. Mostrar PlaQui.
 204                 @endif
 205
 206 @section preguntas Preguntas.
 207
 208 @section fin FIN
 209
 210 */