summaryrefslogtreecommitdiffstats
path: root/include/dialogs
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2016-01-07 08:54:24 +0100
committerDave Davenport <qball@gmpclient.org>2016-01-07 08:54:24 +0100
commit504e27f7019391f759311fb5b1896a3265998bae (patch)
tree00db6739ab8feb98f0ed98e9b4d6b2ad57f4aa78 /include/dialogs
parent7f621a4a915792868c09a3d7f9f7a48015c576c8 (diff)
Add some doxygen sugar.
Diffstat (limited to 'include/dialogs')
-rw-r--r--include/dialogs/combi.h15
-rw-r--r--include/dialogs/dialogs.h3
-rw-r--r--include/dialogs/dmenu.h15
-rw-r--r--include/dialogs/drun.h12
-rw-r--r--include/dialogs/run.h1
-rw-r--r--include/dialogs/script.h13
-rw-r--r--include/dialogs/ssh.h1
-rw-r--r--include/dialogs/window.h13
8 files changed, 58 insertions, 15 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