diff options
author | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-06 09:05:15 +0000 |
---|---|---|
committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-06 09:05:15 +0000 |
commit | 8da7cad86d957e3dc7126adc4a678e1d431ecaf1 (patch) | |
tree | e99d3939dc43fb6c5c6a615d60f1b5e9479001bd /os | |
parent | 6ecd7c2bf023df721108ea64779895a1b9e6e0c8 (diff) | |
download | ChibiOS-8da7cad86d957e3dc7126adc4a678e1d431ecaf1.tar.gz ChibiOS-8da7cad86d957e3dc7126adc4a678e1d431ecaf1.tar.bz2 ChibiOS-8da7cad86d957e3dc7126adc4a678e1d431ecaf1.zip |
Small documentation fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12532 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os')
-rw-r--r-- | os/hal/dox/ext.dox | 2 | ||||
-rw-r--r-- | os/hal/include/hal_pal.h | 2 | ||||
-rw-r--r-- | os/hal/src/hal_pal.c | 4 |
3 files changed, 5 insertions, 3 deletions
diff --git a/os/hal/dox/ext.dox b/os/hal/dox/ext.dox index 1eed75e5b..b59269c43 100644 --- a/os/hal/dox/ext.dox +++ b/os/hal/dox/ext.dox @@ -18,6 +18,8 @@ * @defgroup EXT EXT Driver
* @brief Generic EXT Driver.
* @details This module implements a generic EXT (EXTernal) driver.
+ * @note This driver is obsolete. Use the Event and Callback functions
+ * of the @ref PAL driver instead.
* @pre In order to use the EXT driver the @p HAL_USE_EXT option
* must be enabled in @p halconf.h.
*
diff --git a/os/hal/include/hal_pal.h b/os/hal/include/hal_pal.h index 9e0781554..251cf01ae 100644 --- a/os/hal/include/hal_pal.h +++ b/os/hal/include/hal_pal.h @@ -975,7 +975,7 @@ typedef struct { * @param[in] cb event callback function
* @param[in] arg callback argument
*
- * @iclass
+ * @api
*/
#define palSetLineCallback(line, cb, arg) \
do { \
diff --git a/os/hal/src/hal_pal.c b/os/hal/src/hal_pal.c index ab07b5216..da82abc53 100644 --- a/os/hal/src/hal_pal.c +++ b/os/hal/src/hal_pal.c @@ -126,7 +126,7 @@ void palSetBusMode(const IOBus *bus, iomode_t mode) { * @param[in] cb event callback function
* @param[in] arg callback argument
*
- * @api
+ * @iclass
*/
void palSetPadCallbackI(ioportid_t port, iopadid_t pad,
palcallback_t cb, void *arg) {
@@ -143,7 +143,7 @@ void palSetPadCallbackI(ioportid_t port, iopadid_t pad, * @param[in] cb event callback function
* @param[in] arg callback argument
*
- * @api
+ * @iclass
*/
void palSetLineCallbackI(ioline_t line, palcallback_t cb, void *arg) {
|