From 0672a430f7581bd6e325ab18e49346beb6b1bb9d Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 18 Sep 2010 10:28:03 +0000 Subject: Files related documentation fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2182 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/chfiles.h | 12 ++++++------ os/kernel/kernel.dox | 9 +++++++-- 2 files changed, 13 insertions(+), 8 deletions(-) (limited to 'os/kernel') 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.
+ * @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.
* 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 */ -- cgit v1.2.3