X-Git-Url: https://git.llucax.com/z.facultad/75.06/emufs.git/blobdiff_plain/32acd8ef1fd264c969d59dffc89f00239935eb99..439bc9dba0fb23fa34afeebb80e1288d9f8d39f4:/emufs_gui/menu.h?ds=sidebyside

diff --git a/emufs_gui/menu.h b/emufs_gui/menu.h
index 7c364d2..4c468e7 100644
--- a/emufs_gui/menu.h
+++ b/emufs_gui/menu.h
@@ -8,6 +8,20 @@
 #include <menu.h>
 #include <string.h>
 
+/** Estructura de Menu
+ *
+ *  Para crear un menu puede utilizar las macros que se dan, de la siguiente forma :
+ *  \code
+ *    MENU(mi_menu) {
+ *      MENU_OPCION("Valor 1", "Descripcion 1"),
+ *      MENU_OPCION("Valor 2", "Descripcion 2"),
+ *      MENU_OPCION("Valor 3", "Descripcion 3"),
+ *      MENU_OPCION("Valor 4", "Descripcion 4")
+ *    };
+ *  \endcode
+ *  Tenga en cuenta que la última opción no debe llevar una coma
+ *  al final de la expresión.
+ */
 typedef struct _menu_o_t_ {
 	char *opt;
 	char *desc;
@@ -18,6 +32,13 @@ typedef struct _menu_o_t_ {
 
 #define MENU_OPCION(a,b) {a, b}
 
+/** Ejecuta un menu en pantalla
+ *
+ *  \param menu Menú a mostrar
+ *  \param cant Cantidad de opciones del menu
+ *  \param title Título a mostrar
+ *  \return valor de 0 a (n-1) de la opción seleccionada
+ */
 int menu_ejecutar(t_Menu menu[], int cant, char *title);
 
 #endif