summaryrefslogtreecommitdiffstats
path: root/include/history.h
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2016-01-05 21:31:17 +0100
committerDave Davenport <qball@gmpclient.org>2016-01-05 21:31:17 +0100
commit0b2628739641361f421381cca6b6eb23f7d5572a (patch)
tree5d22057d719fd9dacd1e25fb21543632cc16944e /include/history.h
parent81ea5fd8c6cab7606cec7e42cf1b1ed62cce3380 (diff)
Add small wrapper around history.
Diffstat (limited to 'include/history.h')
-rw-r--r--include/history.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/include/history.h b/include/history.h
index 96b36840..8f188416 100644
--- a/include/history.h
+++ b/include/history.h
@@ -2,6 +2,17 @@
#define ROFI_HISTORY_H
/**
+ * @defgroup HISTORY History
+ *
+ * Implements a very simple history module that can be used by a #Mode.
+ *
+ * This uses the following options from the #config object:
+ * * #_Settings::disable_history
+ *
+ * @{
+ */
+
+/**
* @param filename The filename of the history cache.
* @param entry The entry to add/increment
*
@@ -27,4 +38,5 @@ void history_remove ( const char *filename, const char *entry ) __attribute__( (
*/
char ** history_get_list ( const char *filename, unsigned int * length ) __attribute__( ( nonnull ) );
-#endif
+/*@}*/
+#endif // ROFI_HISTORY_H