[MPlayer-cvslog] r35618 - trunk/gui/interface.c

[ib]

Author: ib
Date: Thu Dec  6 03:30:19 2012
New Revision: 35618

Log:
Add doxygen comments.

Modified:
   trunk/gui/interface.c

Modified: trunk/gui/interface.c
==============================================================================
--- trunk/gui/interface.c	Thu Dec  6 03:11:28 2012	(r35617)
+++ trunk/gui/interface.c	Thu Dec  6 03:30:19 2012	(r35618)
@@ -58,6 +58,9 @@
 #include "sub/sub.h"
 #include "sub/subreader.h"
 
+/**
+ * @brief Initialize interface data.
+ */
 guiInterface_t guiInfo = {
     .StreamType   = STREAMTYPE_DUMMY,
     .Balance      = 50.0f,
@@ -68,6 +71,9 @@ static int initialized;
 
 /* MPlayer -> GUI */
 
+/**
+ * @brief Initialize and start the GUI.
+ */
 void guiInit(void)
 {
     int i;
@@ -254,6 +260,9 @@ void guiInit(void)
     initialized = True;
 }
 
+/**
+ * @brief Stop and finalize the GUI.
+ */
 void guiDone(void)
 {
     if (initialized) {
@@ -323,6 +332,16 @@ static void add_vf(char *str)
     mp_msg(MSGT_GPLAYER, MSGL_INFO, MSGTR_AddingVideoFilter, str);
 }
 
+/**
+ * @brief Issue a command to the GUI.
+ *
+ * @note The GUI is controlled by giving it commands.
+ *
+ * @param what command to be performed
+ * @param data pointer to data needed for the command
+ *
+ * @return #True (ok) or #False (error)
+ */
 int gui(int what, void *data)
 {
     mixer_t *mixer = NULL;