* Agrego mas documentacion de las API's

[z.facultad/75.06/emufs.git] / emufs_gui / gui.h

diff --git a/emufs_gui/gui.h b/emufs_gui/gui.h
index 7c97a6f8cbe52155d46a503b20dc906a66ac5b7d..351f2c493cb3b2347facad3abd34b6b0424236e3 100644 (file)
--- a/emufs_gui/gui.h
+++ b/emufs_gui/gui.h
@@ -2,8 +2,25 @@
 #ifndef _GUI_H_
 #define _GUI_H_
 
-/* cuadro de msg. w y h son de la ventana padre */
+/** Crea un cuadro de mensaje
+ *
+ *  Se puede utilizar para dar avisos o dejar un mensaje mientras
+ *  se va a procesar un tarea larga, por ejemplo :
+ *  \code
+ *    WINDOW *w = msg_box(padre, 10, 10, "Se van a eliminar %d elementos. Aguarde", n);
+ *    do_delete();
+ *    msg_box_free(w);
+ *  \endcode
+ *
+ *  \param win Ventana padre
+ *  \param w Ancho de la ventana padre
+ *  \param h Alto de la ventana padre
+ *  \param format Formato compatible con printf
+ *  \return Una ventana creada.
+ */
 WINDOW *msg_box(WINDOW *win, int w, int h, const char *format, ...);
+
+/** Libera un dialogo creado */
 void msg_box_free(WINDOW *padre, WINDOW *win);
 
 #endif