From e9f502f1713049fb7f4e9cae67f8df8c919c72a2 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Fri, 23 Mar 2018 11:58:28 +0000 Subject: Documentation fixes to the ICU driver. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11840 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- os/hal/include/hal_icu.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'os/hal/include') diff --git a/os/hal/include/hal_icu.h b/os/hal/include/hal_icu.h index 8408b4a1d..89c4a62ef 100644 --- a/os/hal/include/hal_icu.h +++ b/os/hal/include/hal_icu.h @@ -102,7 +102,8 @@ typedef void (*icucallback_t)(ICUDriver *icup); /** * @brief Enables notifications. - * @pre The ICU unit must have been activated using @p icuStart(). + * @pre The ICU unit must have been activated using @p icuStart() and the + * capture started using @p icuStartCapture(). * @note If the notification is already enabled then the call has no effect. * * @param[in] icup pointer to the @p ICUDriver object @@ -113,7 +114,8 @@ typedef void (*icucallback_t)(ICUDriver *icup); /** * @brief Disables notifications. - * @pre The ICU unit must have been activated using @p icuStart(). + * @pre The ICU unit must have been activated using @p icuStart() and the + * capture started using @p icuStartCapture(). * @note If the notification is already disabled then the call has no effect. * * @param[in] icup pointer to the @p ICUDriver object -- cgit v1.2.3