diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-02-22 11:34:04 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-02-22 11:34:04 +0000 |
| commit | d4c246e1bf9af0096b69ded8ae65bbf754267754 (patch) | |
| tree | 234cff7b0a84068b3b6dedca795ba71faa9f1a7b /os/hal/include | |
| parent | 4149bab2ca98e041d09d9908b04e634b84257f2c (diff) | |
| download | ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.tar.gz ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.tar.bz2 ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.zip | |
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@5298 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include')
| -rw-r--r-- | os/hal/include/io_block.h | 6 | ||||
| -rw-r--r-- | os/hal/include/io_channel.h | 13 | ||||
| -rw-r--r-- | os/hal/include/mmcsd.h | 2 |
3 files changed, 12 insertions, 9 deletions
diff --git a/os/hal/include/io_block.h b/os/hal/include/io_block.h index 95c0f4bca..da0e97d8a 100644 --- a/os/hal/include/io_block.h +++ b/os/hal/include/io_block.h @@ -21,12 +21,12 @@ /**
* @file io_block.h
* @brief I/O block devices access.
- * @details This header defines abstract interfaces useful to access generic
+ * @details This header defines an abstract interface useful to access generic
* I/O block devices in a standardized way.
*
* @addtogroup IO_BLOCK
- * @details This module define an abstract interface for accessing generic
- * block devices.
+ * @details This module defines an abstract interface for accessing generic
+ * block devices.<br>
* Note that no code is present, just abstract interfaces-like
* structures, you should look at the system as to a set of
* abstract C++ classes (even if written in C). This system
diff --git a/os/hal/include/io_channel.h b/os/hal/include/io_channel.h index b7ef0f311..af90b431e 100644 --- a/os/hal/include/io_channel.h +++ b/os/hal/include/io_channel.h @@ -21,16 +21,17 @@ /**
* @file io_channel.h
* @brief I/O channels access.
- * @details This header defines abstract interfaces useful to access generic
+ * @details This header defines an abstract interface useful to access generic
* I/O serial devices in a standardized way.
*
* @addtogroup IO_CHANNEL
* @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>
+ * extending the @p BaseSequentialStream interface.<br>
+ * 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/hal/include/mmcsd.h b/os/hal/include/mmcsd.h index 6a0bd8ab1..c782ab7a2 100644 --- a/os/hal/include/mmcsd.h +++ b/os/hal/include/mmcsd.h @@ -21,6 +21,8 @@ /**
* @file mmcsd.h
* @brief MMC/SD cards common header.
+ * @details This header defines an abstract interface useful to access MMC/SD
+ * I/O block devices in a standardized way.
*
* @addtogroup MMCSD
* @{
|