Commit 619f812090fc6d6b41338f4d7a8bafe45637f684

Thomas de Grivel 2022-08-09T07:29:28

document flags

diff --git a/librtbuf/rtbuf.h b/librtbuf/rtbuf.h
index 2f2097d..b41246b 100644
--- a/librtbuf/rtbuf.h
+++ b/librtbuf/rtbuf.h
@@ -31,9 +31,24 @@
 #include "type.h"
 #include "proc.h"
 
+/**
+ * @brief Rtbuf sort flag. Set if buffer order was changed.
+ */
 #define RTBUF_SORT     0x0001
+
+/**
+ * @brief Rtbuf delete flag. Set if buffer should be deleted.
+ */
 #define RTBUF_DELETE   0x0002
+
+/**
+ * @brief Rtbuf new flag. Set when buffer is new and should be started.
+ */
 #define RTBUF_NEW      0x0004
+
+/**
+ * @brief Rtbuf ready flag. Set when buffer is ready to use.
+ */
 #define RTBUF_READY    0x0008
 
 /**