changeset 35524:dd7de6052739

Add doxygen comments.
author ib
date Thu, 06 Dec 2012 02:30:19 +0000
parents 1857fa5cbfcb
children e27855a45128
files gui/interface.c
diffstat 1 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/gui/interface.c	Thu Dec 06 02:11:28 2012 +0000
+++ b/gui/interface.c	Thu Dec 06 02:30:19 2012 +0000
@@ -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 @@
 
 /* MPlayer -> GUI */
 
+/**
+ * @brief Initialize and start the GUI.
+ */
 void guiInit(void)
 {
     int i;
@@ -254,6 +260,9 @@
     initialized = True;
 }
 
+/**
+ * @brief Stop and finalize the GUI.
+ */
 void guiDone(void)
 {
     if (initialized) {
@@ -323,6 +332,16 @@
     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;