* Mas Doc de la API

diff --git a/gui/form.h b/gui/form.h
index d02da16ee70ab32626373b3b57667fa015eb963a..82271503c165e65afa562d6e255578477a3bc55d 100644 (file)
--- a/gui/form.h
+++ b/gui/form.h
@@ -52,15 +52,52 @@ typedef struct _form_ {
        WINDOW *win;
 } t_Form;
 
-/* Inicializa un formulario */
+/** Inicializa un formulario
+ *
+ *  \param win Ventana a la que pertenece
+ * */
 t_Form *form_crear(WINDOW *win);
-/* Libera un formulario */
+
+/** Libera un formulario */
 int form_destruir(t_Form *);
-/* Agrega un nuevo campo */
-void form_agregar_widget(t_Form *, t_Campo tipo, const char *nombre, unsigned int max, const char *defecto);
-/* Ejecuta una entrada del formulario */
-void form_ejecutar(t_Form *, int x, int y);
-char *form_obtener_valor(t_Form *, const char *widget);
+/** Agrega un nuevo campo
+ *
+ *  Significado de <em>max</em> según tipo:
+ *    INPUT : Cantidad máxima de caracteres de la entrada.
+ *    RADIO : Cantidad de opciones
+ *
+ *  Significado de <em>defecto</em> según tipo
+ *    INPUT : Nada.
+ *    RADIO : Texto separado por comas (',') de las opciones disponibles.
+ *
+ *  \param f Formulario
+ *  \param tipo Tipo de campo a agregar [INPUT|RADIO].
+ *  \param nombre Nombre del campo. Es también utilizado como etiqueta.
+ *  \param max Su uso depende del campo tipo.
+ *  \param defecto Su uso depende del campo tipo.
+ */
+void form_agregar_widget(t_Form *f, t_Campo tipo, const char *nombre, unsigned int max, const char *defecto);
+
+/** Ejecuta una entrada del formulario
+ *
+ *  Esta función va recorriendo uno por uno los campos del formulario
+ *  y dependiendo del tipo ejecutando su acción asociada.
+ *
+ *  Cuando se ha pasado por todos los campos el formulario retorna el control.
+ *
+ *  \param f Formulario.
+ *  \param x Coordenada X de inicio del formulario.
+ *  \param y Coordenada Y de inicio del formulario.
+ */
+void form_ejecutar(t_Form *f, int x, int y);
+
+/** Obtiene el valor asociado a un campo
+ *
+ *  \param f Formulario.
+ *  \param widget Nombre del campo.
+ *  \return "" Si no se encontro nada.
+ */
+char *form_obtener_valor(t_Form *f, const char *widget);
 
 #endif