changeset 35643:f8eb470c25ea

Add doxygen comments.

--- a/gui/dialog/dialog.c	Fri Jan 11 23:59:01 2013 +0000
+++ b/gui/dialog/dialog.c	Sat Jan 12 00:04:24 2013 +0000
@@ -75,6 +75,16 @@
 
 guiIcon_t guiIcon;
 
+/**
+ * @brief Add an icon to the #guiIcon icon structure.
+ *
+ * @param theme theme to load the icon from
+ * @param size size of the icon to load
+ * @param gdkIcon location to store a pointer to the created pixmap
+ * @param gdkIconMask location to store a pointer to the created mask
+ *
+ * @return #True (ok) or #False (error)
+ */
 static int gtkLoadIcon(GtkIconTheme *theme, gint size, GdkPixmap **gdkIcon, GdkBitmap **gdkIconMask)
 {
     GdkPixbuf *pixbuf;
@@ -115,6 +125,11 @@
     return (pixbuf != NULL);
 }
 
+/**
+ * @brief Initialize the GTK user interface.
+ *
+ * @param display_name name of the X display to use or NULL (using the DISPLAY environment variable)
+ */
 void gtkInit(char *display_name)
 {
     int argc = 0;
@@ -156,6 +171,11 @@
     gtkInitialized = True;
 }
 
+/**
+ * @brief Add the #guiIcon icons to a GTK window.
+ *
+ * @param window pointer to a GtkWindow widget
+ */
 void gtkAddIcon(GtkWidget *window)
 {
     wsSetIcon(gdk_display, GDK_WINDOW_XWINDOW(window->window), &guiIcon);
@@ -242,12 +262,22 @@
             gtk_main_iteration_do(0);
 }
 
+/**
+ * @brief Set the layer for a GTK window.
+ *
+ * @param window pointer to a GtkWindow widget
+ */
 void gtkSetLayer(GtkWidget *window)
 {
     wsSetLayer(gdk_display, GDK_WINDOW_XWINDOW(window->window), guiApp.videoWindow.isFullScreen);
     gtkActive(window);
 }
 
+/**
+ * @brief Activate a GTK window, i.e. raise it to the top.
+ *
+ * @param window pointer to a GtkWindow widget
+ */
 void gtkActive(GtkWidget *window)
 {
     wsRaiseWindowTop(gdk_display, GDK_WINDOW_XWINDOW(window->window));

--- a/gui/wm/ws.c	Fri Jan 11 23:59:01 2013 +0000
+++ b/gui/wm/ws.c	Sat Jan 12 00:04:24 2013 +0000
@@ -985,6 +985,13 @@
 #define WIN_LAYER_NORMAL                 4
 #define WIN_LAYER_ONTOP                 10
 
+/**
+ * @brief Set the layer for a window.
+ *
+ * @param display display
+ * @param Win window
+ * @param fullscreen whether to set fullscreen or normal layer
+ */
 void wsSetLayer(Display *display, Window Win, Bool fullscreen)
 {
     vo_x11_setlayer(display, Win, fullscreen);