aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2019-01-20 16:23:16 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2019-01-20 16:23:16 +0000
commitac1e9f31ced461e6a999e71eb1bc50965e1a1597 (patch)
tree4eaefa2d9f053ed4c1740ec9b052b09418acb2cd /os/hal
parente15fc5236be4f5b091ba3a946acaad5dda1d7904 (diff)
downloadChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.tar.gz
ChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.tar.bz2
ChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.zip
Documentation cleanup, not finished.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12567 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal')
-rw-r--r--os/hal/dox/flash.dox4
-rw-r--r--os/hal/dox/hal_peripherals.dox4
-rw-r--r--os/hal/dox/mfs.dox2
-rw-r--r--os/hal/dox/norflash.dox27
-rw-r--r--os/hal/lib/complex/serial_nor/hal_serial_nor.h2
-rw-r--r--os/hal/lib/streams/chprintf.c2
-rw-r--r--os/hal/lib/streams/chprintf.h2
-rw-r--r--os/hal/lib/streams/memstreams.c2
-rw-r--r--os/hal/lib/streams/memstreams.h2
-rw-r--r--os/hal/lib/streams/nullstreams.c2
-rw-r--r--os/hal/lib/streams/nullstreams.h2
11 files changed, 17 insertions, 34 deletions
diff --git a/os/hal/dox/flash.dox b/os/hal/dox/flash.dox
index 8cfb5c3d7..4cf395292 100644
--- a/os/hal/dox/flash.dox
+++ b/os/hal/dox/flash.dox
@@ -15,8 +15,8 @@
*/
/**
- * @defgroup HAL_FLASH Generic Flash Driver Interface
- * @brief HAL Generic Flash Driver Interface.
+ * @defgroup HAL_FLASH Generic NOR Flash Interface
+ * @brief HAL Generic NOR Flash Driver Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/
diff --git a/os/hal/dox/hal_peripherals.dox b/os/hal/dox/hal_peripherals.dox
index ac46d74b9..406ff46dc 100644
--- a/os/hal/dox/hal_peripherals.dox
+++ b/os/hal/dox/hal_peripherals.dox
@@ -15,8 +15,8 @@
*/
/**
- * @defgroup HAL_ABSTRACT_PERIPHERALS Abstract Peripheral Interfaces
+ * @defgroup HAL_ABSTRACT_PERIPHERALS Peripheral Interfaces
* @brief HAL Abstract Peripheral Interfaces.
*
- * @ingroup HAL_INTERFACES
+ * @ingroup IO
*/
diff --git a/os/hal/dox/mfs.dox b/os/hal/dox/mfs.dox
index 359cb2f9e..88b80468a 100644
--- a/os/hal/dox/mfs.dox
+++ b/os/hal/dox/mfs.dox
@@ -15,7 +15,7 @@
*/
/**
- * @defgroup MFS Managed Flash Storage Driver
+ * @defgroup HAL_MFS Managed Flash Storage Driver
* @brief Managed Flash Storage Driver.
* @details This module implements a managed flash storage able to store
* a finite number of variable-size records. Records are retrieved
diff --git a/os/hal/dox/norflash.dox b/os/hal/dox/norflash.dox
index 1cc4a758a..2196363bd 100644
--- a/os/hal/dox/norflash.dox
+++ b/os/hal/dox/norflash.dox
@@ -15,9 +15,10 @@
*/
/**
- * @defgroup NOR_FLASH Abstract NOR Flash Class
- * @brief Generic NOR Flash interface.
- * @details This module implements a generic class for NOR Flash devices.
+ * @defgroup HAL_SERIAL_NOR Serial NOR Flash Driver
+ * @brief Serial NOR Flash driver.
+ * @details This module implements a generic driver for serial NOR Flash
+ * devices.
*
* @section flash_1 Driver State Machine
* The flash driver implements a state machine internally, not all the driver
@@ -53,23 +54,5 @@
}
* @enddot
*
- * @section flash_2 Flash Operations.
- * This driver abstracts a generic PWM timer composed of:
- * - A clock prescaler.
- * - A main up counter.
- * - A comparator register that resets the main counter to zero when the limit
- * is reached. An optional callback can be generated when this happens.
- * - An array of @p PWM_CHANNELS PWM channels, each channel has an output,
- * a comparator and is able to invoke an optional callback when a comparator
- * match with the main counter happens.
- * .
- * A PWM channel output can be in two different states:
- * - <b>IDLE</b>, when the channel is disabled or after a match occurred.
- * - <b>ACTIVE</b>, when the channel is enabled and a match didn't occur yet
- * in the current PWM cycle.
- * .
- * Note that the two states can be associated to both logical zero or one in
- * the @p PWMChannelConfig structure.
- *
- * @ingroup HAL_INTERFACES
+ * @ingroup HAL_COMPLEX_DRIVERS
*/
diff --git a/os/hal/lib/complex/serial_nor/hal_serial_nor.h b/os/hal/lib/complex/serial_nor/hal_serial_nor.h
index 81c66f0c9..f9f7a747f 100644
--- a/os/hal/lib/complex/serial_nor/hal_serial_nor.h
+++ b/os/hal/lib/complex/serial_nor/hal_serial_nor.h
@@ -18,7 +18,7 @@
* @file serial_nor.h
* @brief Serial NOR driver header.
*
- * @addtogroup SERIAL_NOR
+ * @addtogroup HAL_SERIAL_NOR
* @{
*/
diff --git a/os/hal/lib/streams/chprintf.c b/os/hal/lib/streams/chprintf.c
index ba622446c..e9c4747e2 100644
--- a/os/hal/lib/streams/chprintf.c
+++ b/os/hal/lib/streams/chprintf.c
@@ -23,7 +23,7 @@
* @file chprintf.c
* @brief Mini printf-like functionality.
*
- * @addtogroup chprintf
+ * @addtogroup HAL_CHPRINTF
* @{
*/
diff --git a/os/hal/lib/streams/chprintf.h b/os/hal/lib/streams/chprintf.h
index 833ac27f4..9eb3afd01 100644
--- a/os/hal/lib/streams/chprintf.h
+++ b/os/hal/lib/streams/chprintf.h
@@ -18,7 +18,7 @@
* @file chprintf.h
* @brief Mini printf-like functionality.
*
- * @addtogroup chprintf
+ * @addtogroup HAL_CHPRINTF
* @{
*/
diff --git a/os/hal/lib/streams/memstreams.c b/os/hal/lib/streams/memstreams.c
index 6bbd66cef..a06b0a3a1 100644
--- a/os/hal/lib/streams/memstreams.c
+++ b/os/hal/lib/streams/memstreams.c
@@ -18,7 +18,7 @@
* @file memstreams.c
* @brief Memory streams code.
*
- * @addtogroup memory_streams
+ * @addtogroup HAL_MEMORY_STREAMS
* @{
*/
diff --git a/os/hal/lib/streams/memstreams.h b/os/hal/lib/streams/memstreams.h
index cc10ae8d5..0c2236bab 100644
--- a/os/hal/lib/streams/memstreams.h
+++ b/os/hal/lib/streams/memstreams.h
@@ -18,7 +18,7 @@
* @file memstreams.h
* @brief Memory streams structures and macros.
- * @addtogroup memory_streams
+ * @addtogroup HAL_MEMORY_STREAMS
* @{
*/
diff --git a/os/hal/lib/streams/nullstreams.c b/os/hal/lib/streams/nullstreams.c
index c15455b22..51206e943 100644
--- a/os/hal/lib/streams/nullstreams.c
+++ b/os/hal/lib/streams/nullstreams.c
@@ -18,7 +18,7 @@
* @file nullstreams.c
* @brief Null streams code.
*
- * @addtogroup null_streams
+ * @addtogroup HAL_NULL_STREAMS
* @{
*/
diff --git a/os/hal/lib/streams/nullstreams.h b/os/hal/lib/streams/nullstreams.h
index 1d652a97f..c87481597 100644
--- a/os/hal/lib/streams/nullstreams.h
+++ b/os/hal/lib/streams/nullstreams.h
@@ -18,7 +18,7 @@
* @file nullstreams.h
* @brief Null streams structures and macros.
- * @addtogroup null_streams
+ * @addtogroup HAL_NULL_STREAMS
* @{
*/