Add some doxygen sugar.

18 files changed, 143 insertions, 23 deletions

diff --git a/include/dialogs/combi.h b/include/dialogs/combi.h
index fc3a64ae..a3082c4a 100644
--- a/include/dialogs/combi.h
+++ b/include/dialogs/combi.h
@@ -1,5 +1,14 @@
-#ifndef __COMBI_DIALOG_H__
-#define __COMBI_DIALOG_H__
+#ifndef ROFI_DIALOG_COMBI_H
+#define ROFI_DIALOG_COMBI_H
+
+/**
+ * @defgroup COBIMode Combi
+ * @ingroup MODES
+ *
+ * @{
+ */
 
 extern Mode combi_mode;
-#endif
+
+/*@}*/
+#endif // ROFI_DIALOG_COMBI_H
diff --git a/include/dialogs/dialogs.h b/include/dialogs/dialogs.h
index 382784d5..2690bc90 100644
--- a/include/dialogs/dialogs.h
+++ b/include/dialogs/dialogs.h
@@ -2,6 +2,9 @@
 #define ROFI_DIALOGS_DIALOGS_H
 
 /**
+ * @defgroup MODES Modes
+ */
+/**
  * List of available dialogs.
  */
 
diff --git a/include/dialogs/dmenu.h b/include/dialogs/dmenu.h
index ae0eefe9..a495fe44 100644
--- a/include/dialogs/dmenu.h
+++ b/include/dialogs/dmenu.h
@@ -1,7 +1,14 @@
-#ifndef __DMENU_DIALOG_H__
-#define __DMENU_DIALOG_H__
+#ifndef ROFI_DIALOG_DMENU_H
+#define ROFI_DIALOG_DMENU_H
 
 /**
+ * @defgroup DMENU DMenu
+ * @ingroup MODES
+ *
+ *
+ * @{
+ */
+/**
  * dmenu dialog.
  *
  * @returns TRUE if script was successful.
@@ -9,4 +16,6 @@
 int dmenu_switcher_dialog ( void );
 
 void print_dmenu_options ( void );
-#endif
+
+/*@}*/
+#endif // ROFI_DIALOG_DMENU_H
diff --git a/include/dialogs/drun.h b/include/dialogs/drun.h
index ac493a6d..46199736 100644
--- a/include/dialogs/drun.h
+++ b/include/dialogs/drun.h
@@ -1,5 +1,11 @@
-#ifndef __DRUN_DIALOG_H__
-#define __DRUN_DIALOG_H__
+#ifndef ROFI_DIALOG_DRUN_H
+#define ROFI_DIALOG_DRUN_H
 
+/**
+ * @defgroup DRUNMode DRun
+ * @ingroup MODES
+ * @{
+ */
 extern Mode drun_mode;
-#endif
+/*@}*/
+#endif // ROFI_DIALOG_DRUN_H
diff --git a/include/dialogs/run.h b/include/dialogs/run.h
index 860aad9c..c6b5d13d 100644
--- a/include/dialogs/run.h
+++ b/include/dialogs/run.h
@@ -3,6 +3,7 @@
 
 /**
  * @defgroup RUNMode Run
+ * @ingroup MODES
  *
  * This mode uses the following options from the #config object:
  *  * #_Settings::run_command
diff --git a/include/dialogs/script.h b/include/dialogs/script.h
index aa73cb09..46b9ab6f 100644
--- a/include/dialogs/script.h
+++ b/include/dialogs/script.h
@@ -1,7 +1,13 @@
-#ifndef __SCRIPT_DIALOG_H__
-#define __SCRIPT_DIALOG_H__
+#ifndef ROFI_DIALOG_SCRIPT_H
+#define ROFI_DIALOG_SCRIPT_H
 
 /**
+ * @defgroup SCRIPTMode Script
+ * @ingroup MODES
+ *
+ * @{
+ */
+/**
  * @param str   The input string to parse
  *
  * Parse an argument string into the right ScriptOptions data object.
@@ -10,4 +16,5 @@
  * @returns NULL when it fails, a newly allocated ScriptOptions when successful.
  */
 Mode *script_switcher_parse_setup ( const char *str );
-#endif
+/*@}*/
+#endif // ROFI_DIALOG_SCRIPT_H
diff --git a/include/dialogs/ssh.h b/include/dialogs/ssh.h
index 0e026ee5..55326cb4 100644
--- a/include/dialogs/ssh.h
+++ b/include/dialogs/ssh.h
@@ -3,6 +3,7 @@
 
 /**
  * @defgroup SSHMode SSH
+ * @ingroup MODES
  *
  * SSH Mode, returns a list of known SSH hosts the user can log into.
  * It does this by parsing the SSH config file and optional the known host  and host list
diff --git a/include/dialogs/window.h b/include/dialogs/window.h
index 909e4cad..7a43170c 100644
--- a/include/dialogs/window.h
+++ b/include/dialogs/window.h
@@ -1,10 +1,17 @@
-#ifndef __WINDOW_DIALOG_H__
-#define __WINDOW_DIALOG_H__
+#ifndef ROFI_DIALOG_WINDOW_H
+#define ROFI_DIALOG_WINDOW_H
 
+/**
+ * @defgroup WINDOWMode Window
+ * @ingroup MODES
+ *
+ * @{
+ */
 #include <config.h>
 #ifdef WINDOW_MODE
 
 extern Mode window_mode;
 extern Mode window_mode_cd;
 #endif // WINDOW_MODE
-#endif // __WINDOW_DIALOG_H__
+/* @}*/
+#endif // ROFI_DIALOG_WINDOW_H
diff --git a/include/helper.h b/include/helper.h
index f21fd51a..b250604b 100644
--- a/include/helper.h
+++ b/include/helper.h
@@ -1,6 +1,16 @@
 #ifndef ROFI_HELPER_H
 #define ROFI_HELPER_H
 #include "rofi.h"
+
+/**
+ * @defgroup HELPERS Helpers
+ */
+/**
+ * @defgroup HELPER Helper
+ * @ingroup HELPERS
+ *
+ * @{
+ */
 /**
  * @param string The input string.
  * @param output Pointer to 2 dimensional array with parsed string.
@@ -155,4 +165,6 @@ void cmd_set_arguments ( int argc, char **argv );
  */
 char *rofi_expand_path ( const char *input );
 unsigned int levenshtein ( const char *needle, const char *haystack );
+
+/*@}*/
 #endif // ROFI_HELPER_H
diff --git a/include/history.h b/include/history.h
index 8f188416..95a8a048 100644
--- a/include/history.h
+++ b/include/history.h
@@ -3,6 +3,7 @@
 
 /**
  * @defgroup HISTORY History
+ * @ingroup HELPERS
  *
  * Implements a very simple history module that can be used by a #Mode.
  *
diff --git a/include/i3-support.h b/include/i3-support.h
index 9030f804..1e73fe73 100644
--- a/include/i3-support.h
+++ b/include/i3-support.h
@@ -2,7 +2,12 @@
 #define ROFI_I3_H
 
 /**
+ * @defgroup I3Support I3Support
+ * @ingroup HELPERS
+ *
  * These functions are dummies when i3 support is not compiled in.
+ *
+ * @{
  */
 
 /**
@@ -29,4 +34,5 @@ int i3_support_initialize ( Display *display );
  * Cleanup.
  */
 void i3_support_free_internals ( void );
+/*@}*/
 #endif // ROFI_I3_H
diff --git a/include/keyb.h b/include/keyb.h
index 4432a12f..5f4ab520 100644
--- a/include/keyb.h
+++ b/include/keyb.h
@@ -1,6 +1,12 @@
 #ifndef ROFI_KEYB_H
 #define ROFI_KEYB_H
 
+/**
+ * @defgroup KEYB KeyboardBindings
+ *
+ * @{
+ */
+
 typedef enum _KeyBindingAction
 {
     PASTE_PRIMARY = 0,
@@ -80,4 +86,6 @@ void cleanup_abe ( void );
  * @returns TRUE if key combo matches, FALSE otherwise.
  */
 int abe_test_action ( KeyBindingAction action, unsigned int mask, KeySym key );
+
+/*@}*/
 #endif // ROFI_KEYB_H
diff --git a/include/rofi.h b/include/rofi.h
index 9571765e..62e0e8ab 100644
--- a/include/rofi.h
+++ b/include/rofi.h
@@ -11,6 +11,10 @@
 #include "keyb.h"
 
 /**
+ * @defgroup Widgets Widgets
+ */
+
+/**
  * Pointer to xdg cache directory.
  */
 extern const char *cache_dir;
diff --git a/include/scrollbar.h b/include/scrollbar.h
index 0b535ea8..e3312854 100644
--- a/include/scrollbar.h
+++ b/include/scrollbar.h
@@ -1,6 +1,13 @@
 #ifndef ROFI_SCROLLBAR_H
 #define ROFI_SCROLLBAR_H
 #include <cairo.h>
+
+/**
+ * @defgroup Scrollbar Scrollbar
+ * @ingroup Widgets
+ *
+ * @{
+ */
 /**
  * Internal structure for the scrollbar.
  */
@@ -90,4 +97,6 @@ void scrollbar_resize ( scrollbar *sb, int w, int h );
  * Move the scrollbar.
  */
 void scrollbar_move ( scrollbar *sb, int x, int y );
+
+/*@}*/
 #endif // ROFI_SCROLLBAR_H
diff --git a/include/textbox.h b/include/textbox.h
index e7aef209..daa57aff 100644
--- a/include/textbox.h
+++ b/include/textbox.h
@@ -7,6 +7,13 @@
 #include <pango/pangocairo.h>
 #include <cairo.h>
 
+/**
+ * @defgroup Textbox Textbox
+ * @ingroup Widgets
+ *
+ * @{
+ */
+
 typedef struct
 {
     double red, green, blue, alpha;
@@ -32,14 +39,14 @@ typedef struct
 
 typedef enum
 {
-    TB_AUTOHEIGHT    = 1 << 0,
-        TB_AUTOWIDTH = 1 << 1,
-        TB_LEFT      = 1 << 16,
-        TB_RIGHT     = 1 << 17,
-        TB_CENTER    = 1 << 18,
-        TB_EDITABLE  = 1 << 19,
-        TB_MARKUP    = 1 << 20,
-        TB_WRAP      = 1 << 21,
+    TB_AUTOHEIGHT = 1 << 0,
+    TB_AUTOWIDTH  = 1 << 1,
+    TB_LEFT       = 1 << 16,
+    TB_RIGHT      = 1 << 17,
+    TB_CENTER     = 1 << 18,
+    TB_EDITABLE   = 1 << 19,
+    TB_MARKUP     = 1 << 20,
+    TB_WRAP       = 1 << 21,
 } TextboxFlags;
 
 typedef enum
@@ -233,4 +240,6 @@ void textbox_delete ( textbox *tb, int pos, int dlen );
 void textbox_moveresize ( textbox *tb, int x, int y, int w, int h );
 int textbox_get_estimated_char_height ( void );
 void textbox_set_pango_context ( PangoContext *p );
+
+/*@}*/
 #endif //ROFI_TEXTBOX_H
diff --git a/include/timings.h b/include/timings.h
index 4d18a4c6..6656867b 100644
--- a/include/timings.h
+++ b/include/timings.h
@@ -1,6 +1,12 @@
 #ifndef ROFI_TIMINGS_H
 #define ROFI_TIMINGS_H
 #include <config.h>
+
+/**
+ * @defgroup TIMINGS Timings
+ * @ingroup HELPERS
+ * @{
+ */
 #if TIMINGS
 
 void rofi_timings_init ( void );
@@ -20,4 +26,5 @@ void rofi_timings_quit ( void );
 #define TICK_N( a )
 
 #endif // TIMINGS
+/*@}*/
 #endif // ROFI_TIMINGS_H
diff --git a/include/x11-helper.h b/include/x11-helper.h
index 61b69532..d8a7ecbc 100644
--- a/include/x11-helper.h
+++ b/include/x11-helper.h
@@ -1,6 +1,12 @@
 #ifndef X11_ROFI_HELPER_H
 #define X11_ROFI_HELPER_H
 
+/**
+ * @defgroup X11Helper X11Helper
+ * @ingroup HELPERS
+ * @{
+ */
+
 int window_get_prop ( Display *display, Window w, Atom prop,
                       Atom *type, int *items,
                       void *buffer, unsigned int bytes ) __attribute__ ( ( nonnull ( 4, 5 ) ) );
@@ -159,4 +165,5 @@ void color_cache_reset ( void );
 cairo_format_t get_format ( void );
 
 void x11_helper_set_cairo_rgba ( cairo_t *d, unsigned int pixel );
+/*@}*/
 #endif
diff --git a/include/xrmoptions.h b/include/xrmoptions.h
index 0d4ffdac..073369f5 100644
--- a/include/xrmoptions.h
+++ b/include/xrmoptions.h
@@ -1,6 +1,18 @@
 #ifndef ROFI_XRMOPTIONS_H
 #define ROFI_XRMOPTIONS_H
 
+/**
+ * @defgroup CONFIGURATION Configuration
+ *
+ * This provides rofi configuration system, supports:
+ * * Compiled defaults.
+ * * XResource parsing
+ * * Config file parsing
+ * * Commandline options.
+ *
+ * @{
+ */
+
 // Big thanks to Sean Pringle for this code.
 // This maps xresource options to config structure.
 typedef enum
@@ -60,4 +72,6 @@ void config_parser_add_option ( XrmOptionType type, const char *key, void **valu
 void print_options ( void );
 void print_help_msg ( const char *option, const char *type, const char*text, const char *def, int isatty );
 void print_xresources_theme ( void );
+
+/* @}*/
 #endif