From 5eec6d12a34acf1095170c786416ae5515202f24 Mon Sep 17 00:00:00 2001
From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Thu, 9 Dec 2010 17:56:04 +0000
Subject: [PATCH] doc: Added FIFO module documentation.
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4642 38d2e660-2303-0410-9eaa-f027e97ec537
---
bertos/struct/fifobuf.h | 6 ++++++
doc/general-introduction | 4 ++++
2 files changed, 10 insertions(+)
diff --git a/bertos/struct/fifobuf.h b/bertos/struct/fifobuf.h
index b2f8fa50..f58e1c0a 100644
--- a/bertos/struct/fifobuf.h
+++ b/bertos/struct/fifobuf.h
@@ -30,6 +30,10 @@
* Copyright 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
* -->
*
+ * \defgroup fifobuf FIFO buffer
+ * \ingroup struct
+ * \{
+ *
* \brief General pourpose FIFO buffer implemented with a ring buffer
*
* \li \c begin points to the first buffer element;
@@ -354,4 +358,6 @@ void fifo_pushblock(FIFOBuffer *fb, unsigned char *block, size_t len)
}
#endif
+/** \} */ /* defgroup fifobuf */
+
#endif /* STRUCT_FIFO_H */
diff --git a/doc/general-introduction b/doc/general-introduction
index 8d01d4ac..ff5e5bd5 100644
--- a/doc/general-introduction
+++ b/doc/general-introduction
@@ -101,3 +101,7 @@ int main()
* \defgroup gui BeRTOS GUI toolkit
*
*/
+
+/*!
+ * \defgroup struct Embedded optimized general purpose data types
+ */
--
2.34.1