X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=gui_theme.c;h=b13fdf9f13e3cbc13a19d051f86d09ca9610fcbd;hb=ccd288cee4d15e54640d87c1451b46c3ff0e2591;hp=3c9886d18a2a2a3cbae88a74f79b052391b64672;hpb=9cf149617f6de5a4a16f5f2af39bd532310246dc;p=paraslash.git

diff --git a/gui_theme.c b/gui_theme.c
index 3c9886d1..b13fdf9f 100644
--- a/gui_theme.c
+++ b/gui_theme.c
@@ -4,6 +4,8 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
+/** \file gui_theme.c Theme definitions. */
+
 #include "para.h"
 #include "gui.h"
 #include <curses.h>
@@ -368,6 +370,7 @@ static struct theme_description themes[] = {
 	},
 };
 
+/** Number of elements in the \a themes array. */
 #define NUM_THEMES (ARRAY_SIZE(themes))
 
 static int current_theme_num;
@@ -384,6 +387,14 @@ static void set_theme(int num, struct gui_theme *t)
 	PARA_NOTICE_LOG("theme: %s\n", t->name);
 }
 
+/**
+ * Initialize a theme.
+ *
+ * \param name Name of the theme to be initialized.
+ * \param t The function fills out this structure.
+ *
+ * This function exits if there is no theme called \a name.
+ */
 void theme_init(const char *name, struct gui_theme *t)
 {
 	int i;
@@ -399,11 +410,29 @@ void theme_init(const char *name, struct gui_theme *t)
 	exit(EXIT_FAILURE);
 }
 
+/**
+ * Activate the previous available theme.
+ *
+ * \param t Theme definition is stored here.
+ *
+ * This picks the theme that comes before the currently active one, or the last
+ * availabe theme, if the current one is the first.
+ *
+ * \sa \ref theme_next().
+ */
 void theme_prev(struct gui_theme *t)
 {
 	return set_theme(++current_theme_num, t);
 }
 
+/**
+ * Activate the next available theme.
+ *
+ * \param t Theme definition is stored here.
+ *
+ * This works exacly as theme_prev() but cycles forwards through the list of
+ * available themes.
+ */
 void theme_next(struct gui_theme *t)
 {
 	return set_theme(--current_theme_num, t);