diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-09-18 10:28:03 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-09-18 10:28:03 +0000 |
| commit | 0672a430f7581bd6e325ab18e49346beb6b1bb9d (patch) | |
| tree | 0438d8573662d84b4c4477eb6b72331ceef72687 /os/kernel | |
| parent | fd9d0b74cacfeb38e223c13de25185ea713cad3d (diff) | |
| download | ChibiOS-0672a430f7581bd6e325ab18e49346beb6b1bb9d.tar.gz ChibiOS-0672a430f7581bd6e325ab18e49346beb6b1bb9d.tar.bz2 ChibiOS-0672a430f7581bd6e325ab18e49346beb6b1bb9d.zip | |
Files related documentation fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2182 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/kernel')
| -rw-r--r-- | os/kernel/include/chfiles.h | 12 | ||||
| -rw-r--r-- | os/kernel/kernel.dox | 9 |
2 files changed, 13 insertions, 8 deletions
diff --git a/os/kernel/include/chfiles.h b/os/kernel/include/chfiles.h index ecd03fd04..3053419d9 100644 --- a/os/kernel/include/chfiles.h +++ b/os/kernel/include/chfiles.h @@ -24,12 +24,12 @@ * data files in a standardized way.
*
* @addtogroup data_files
- * @details This module define an abstract interface for generic data files.
- * Note that no code is present, data files 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). This system
- * has the advantage to make the access to streams independent
- * from the implementation logic.<br>
+ * @details This module define an abstract interface for generic data files by
+ * extending the @p BaseSequentialStream interface. Note that no code
+ * is present, data files 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). This system has the advantage to make the
+ * access to streams independent from the implementation logic.<br>
* The data files interface can be used as base class for high level
* object types such as an API for a File System implementation.
* @{
diff --git a/os/kernel/kernel.dox b/os/kernel/kernel.dox index d4206c882..3ec1bfd8a 100644 --- a/os/kernel/kernel.dox +++ b/os/kernel/kernel.dox @@ -134,12 +134,17 @@ */
/**
- * @defgroup data_streams Data Streams
+ * @defgroup data_streams Abstract Sequential Streams
* @ingroup io_support
*/
/**
- * @defgroup io_channels I/O Channels
+ * @defgroup data_files Abstract File Streams
+ * @ingroup io_support
+ */
+
+/**
+ * @defgroup io_channels Abstract I/O Channels
* @ingroup io_support
*/
|