doc: Added FIFO module documentation.
authorlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Thu, 9 Dec 2010 17:56:04 +0000 (17:56 +0000)
committerlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Thu, 9 Dec 2010 17:56:04 +0000 (17:56 +0000)
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4642 38d2e660-2303-0410-9eaa-f027e97ec537

bertos/struct/fifobuf.h
doc/general-introduction

index b2f8fa503e7334448f6d7b0481f4da1f50eef755..f58e1c0a7d0f4e99999298d5af2f63029a4de566 100644 (file)
  * 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 */
index 8d01d4accc8c9da07f2c4da45b350b0b378cc249..ff5e5bd59df8b244791530336f94a10f02adaa9c 100644 (file)
@@ -101,3 +101,7 @@ int main()
  * \defgroup gui BeRTOS GUI toolkit
  *
  */
+
+/*!
+ * \defgroup struct Embedded optimized general purpose data types
+ */