From ad3d21e81592481539a56e93234f5bf1fa2c0504 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Tue, 16 Mar 2010 19:36:21 +0000
Subject: Documentation reorganization. Moved the description from kernel.dox
 into the source code for ease of editing and reference.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1746 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/kernel/include/ch.h        | 1 +
 os/kernel/include/chioch.h    | 8 ++++++++
 os/kernel/include/chstreams.h | 8 ++++++++
 3 files changed, 17 insertions(+)

(limited to 'os/kernel/include')

diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h
index 31845855d..800fc2699 100644
--- a/os/kernel/include/ch.h
+++ b/os/kernel/include/ch.h
@@ -24,6 +24,7 @@
  *          only kernel header you usually want to include in your application.
  *
  * @addtogroup kernel_info
+ * @details Kernel related info.
  * @{
  */
 
diff --git a/os/kernel/include/chioch.h b/os/kernel/include/chioch.h
index c63dadc0e..f8a1f4f98 100644
--- a/os/kernel/include/chioch.h
+++ b/os/kernel/include/chioch.h
@@ -24,6 +24,14 @@
  *          I/O resources in a standardized way.
  *
  * @addtogroup io_channels
+ * @details This module defines an abstract interface for I/O channels by
+ *          extending the @p BaseSequentialStream interface. Note that no code
+ *          is present, I/O channels are just abstract interface like
+ *          structures, you should look at the systems as to a set of abstract
+ *          C++ classes (even if written in C). Specific device drivers can
+ *          use/extend the interface and implement them.<br>
+ *          This system has the advantage to make the access to channels
+ *          independent from the implementation logic.
  * @{
  */
 
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.
  * @{
  */
 
-- 
cgit v1.2.3