aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/include/chstreams.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/kernel/include/chstreams.h')
-rw-r--r--os/kernel/include/chstreams.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/os/kernel/include/chstreams.h b/os/kernel/include/chstreams.h
index 7b55ca539..4681ac331 100644
--- a/os/kernel/include/chstreams.h
+++ b/os/kernel/include/chstreams.h
@@ -24,6 +24,14 @@
* data streams in a standardized way.
*
* @addtogroup data_streams
+ * @details This module define an abstract interface for generic data streams.
+ * Note that no code is present, streams are just abstract interfaces
+ * like structures, you should look at the systems as to a set of
+ * abstract C++ classes (even if written in C). This system has the
+ * advantage to make the access to streams independent from the
+ * implementation logic.<br>
+ * The stream interface can be used as base class for high level
+ * object types such as files, sockets, serial ports, pipes etc.
* @{
*/