From c8a71b258ea2d07162b3e5a1553e1d22a20f157e Mon Sep 17 00:00:00 2001
From: Colomban Wendling <ban@herbesfolles.org>
Date: Sun, 31 Jul 2011 13:35:43 +0000
Subject: [PATCH] Add missing documentation for GeanyInterfacePrefs and
 GeanyToolPrefs

git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@5875 ea778897-0a13-0410-b9d1-a72fbfd435f5
---
 src/prefs.h    |  9 +++++----
 src/ui_utils.h | 40 ++++++++++++++++++++++------------------
 2 files changed, 27 insertions(+), 22 deletions(-)

diff --git a/src/prefs.h b/src/prefs.h
index 436fd0c7f..e0d587a34 100644
--- a/src/prefs.h
+++ b/src/prefs.h
@@ -42,12 +42,13 @@ GeanyPrefs;
 extern GeanyPrefs prefs;
 
 
+/** Tools preferences */
 typedef struct GeanyToolPrefs
 {
-	gchar			*browser_cmd;
-	gchar			*term_cmd;
-	gchar			*grep_cmd;
-	gchar			*context_action_cmd;
+	gchar			*browser_cmd;			/**< web browser command */
+	gchar			*term_cmd;				/**< terminal emulator command */
+	gchar			*grep_cmd;				/**< grep command */
+	gchar			*context_action_cmd;	/**< context action command */
 }
 GeanyToolPrefs;
 
diff --git a/src/ui_utils.h b/src/ui_utils.h
index 27a628322..ab4231b3d 100644
--- a/src/ui_utils.h
+++ b/src/ui_utils.h
@@ -37,27 +37,31 @@
 		g_object_ref(widget), (GDestroyNotify)g_object_unref);
 
 
+/** Interface preferences */
 typedef struct GeanyInterfacePrefs
 {
-	gboolean		sidebar_symbol_visible;
-	gboolean		sidebar_openfiles_visible;
-	gchar			*editor_font;
-	gchar			*tagbar_font;
-	gchar			*msgwin_font;
-	gboolean		show_notebook_tabs;
-	gint			tab_pos_editor;
-	gint			tab_pos_msgwin;
-	gint			tab_pos_sidebar;
-	gboolean		statusbar_visible;
-	gboolean		show_symbol_list_expanders;
+	gboolean		sidebar_symbol_visible;		/**< whether the symbol sidebar is visible */
+	gboolean		sidebar_openfiles_visible;	/**< whether the open file list is visible */
+	gchar			*editor_font;				/**< editor font */
+	gchar			*tagbar_font;				/**< symbol sidebar font */
+	gchar			*msgwin_font;				/**< message window font */
+	gboolean		show_notebook_tabs;			/**< whether editor tabs are visible */
+	gint			tab_pos_editor;				/**< positions of editor's tabs */
+	gint			tab_pos_msgwin;				/**< positions of message window's tabs */
+	gint			tab_pos_sidebar;			/**< positions of sidebar's tabs */
+	gboolean		statusbar_visible;			/**< whether the status bar is visible */
+	gboolean		show_symbol_list_expanders;	/**< whether to show expanders in the symbol list */
+	/** whether a double click on notebook tabs hides all other windows */
 	gboolean		notebook_double_click_hides_widgets;
-	gboolean		highlighting_invert_all;
-	gint			sidebar_pos;
-	gboolean		msgwin_status_visible;
-	gboolean		msgwin_compiler_visible;
-	gboolean		msgwin_messages_visible;
-	gboolean		msgwin_scribble_visible;
-	gboolean		use_native_windows_dialogs; /* only used on Windows */
+	gboolean		highlighting_invert_all; 	/**< whether highlighting colors are inverted */
+	gint			sidebar_pos; 				/**< position of the sidebar (left or right) */
+	gboolean		msgwin_status_visible; 		/**< whether message window's status tab is visible */
+	gboolean		msgwin_compiler_visible;	/**< whether message window's compiler tab is visible */
+	gboolean		msgwin_messages_visible;	/**< whether message window's messages tab is visible */
+	gboolean		msgwin_scribble_visible;	/**< whether message window's scribble tab is visible */
+	/** whether to use native Windows' dialogs (only used on Windows) */
+	gboolean		use_native_windows_dialogs;
+	/** whether compiler messages window is automatically scrolled to show new messages */
 	gboolean		compiler_tab_autoscroll;
 }
 GeanyInterfacePrefs;