From 3d411807c042cf98996f916335cb030cf4f38989 Mon Sep 17 00:00:00 2001
From: Oleg Hahm <oleg@hobbykeller.org>
Date: Wed, 18 Mar 2015 14:27:48 +0100
Subject: [PATCH] doc: fix and complemented some doxygen headers
---
sys/include/chardev_thread.h | 7 +++++++
sys/include/crypto/sha256.h | 6 ------
sys/include/ps.h | 7 +++++++
sys/include/random.h | 5 +++++
4 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/sys/include/chardev_thread.h b/sys/include/chardev_thread.h
index 6921c114fa..a07dd89bef 100644
--- a/sys/include/chardev_thread.h
+++ b/sys/include/chardev_thread.h
@@ -11,6 +11,12 @@
* @defgroup sys_chardevthread Chardev Thread
* @ingroup sys
* @brief Chardev thread
+ * @{
+ *
+ * @file
+ * @brief Handles I/O from a char devices
+ *
+ * @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef __CHARDEV_THREAD_H
@@ -30,3 +36,4 @@ void *chardev_thread_entry(void *rb_);
#endif
#endif /* __CHARDEV_THREAD_H */
+/** @} */
diff --git a/sys/include/crypto/sha256.h b/sys/include/crypto/sha256.h
index 21a27db81b..bac2cf38f9 100644
--- a/sys/include/crypto/sha256.h
+++ b/sys/include/crypto/sha256.h
@@ -28,12 +28,6 @@
*/
-/**
- * @defgroup sys_sha256 SHA264
- * @ingroup sys
- * @brief SHA264 hash generator
- */
-
/**
* @ingroup sys_crypto
* @{
diff --git a/sys/include/ps.h b/sys/include/ps.h
index a15bbf3b3d..fc9753d63d 100644
--- a/sys/include/ps.h
+++ b/sys/include/ps.h
@@ -11,6 +11,12 @@
* @defgroup sys_ps PS
* @ingroup sys
* @brief Show list with all threads
+ * @{
+ *
+ * @file
+ * @brief List information about all active threads
+ *
+ * @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef __PS_H
@@ -28,3 +34,4 @@ void _ps_handler(int argc, char **argv);
#endif
#endif /* __PS_H */
+/** @} */
diff --git a/sys/include/random.h b/sys/include/random.h
index 5b1e10cbe0..2a01d39a1c 100644
--- a/sys/include/random.h
+++ b/sys/include/random.h
@@ -11,6 +11,10 @@
* @defgroup sys_random Random
* @ingroup sys
* @brief Random number generator
+ * @{
+ *
+ * @file
+ * @brief Mersenne Twister - a very fast random number generator
*/
#ifndef RANDOM_H
@@ -85,3 +89,4 @@ double genrand_res53(void);
#endif
#endif /* RANDOM_H */
+/** @} */
--
GitLab