andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes to the ICU driver. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11840 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
Giovanni Di Sirio 2018-03-23 11:58:28 +00:00
parent a9feb30256
commit e9f502f171
4 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
os/hal/include/hal_icu.h
View File

@ -102,7 +102,8 @@ typedef void (*icucallback_t)(ICUDriver *icup);
/** /**
* @brief Enables notifications. * @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. * @note If the notification is already enabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object
@ -113,7 +114,8 @@ typedef void (*icucallback_t)(ICUDriver *icup);
/** /**
* @brief Disables notifications. * @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. * @note If the notification is already disabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object

6
os/hal/ports/STM32/LLD/TIMv1/hal_icu_lld.c
View File

@ -712,7 +712,8 @@ void icu_lld_stop_capture(ICUDriver *icup) {
/** /**
* @brief Enables notifications. * @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. * @note If the notification is already enabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object
@ -758,7 +759,8 @@ void icu_lld_enable_notifications(ICUDriver *icup) {
/** /**
* @brief Disables notifications. * @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. * @note If the notification is already disabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object

6
os/hal/src/hal_icu.c
View File

@ -186,7 +186,8 @@ void icuStopCapture(ICUDriver *icup) {
/** /**
* @brief Enables notifications. * @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. * @note If the notification is already enabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object
@ -206,7 +207,8 @@ void icuEnableNotifications(ICUDriver *icup) {
/** /**
* @brief Disables notifications. * @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. * @note If the notification is already disabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object

6
os/hal/templates/hal_icu_lld.c
View File

@ -154,7 +154,8 @@ void icu_lld_stop_capture(ICUDriver *icup) {
/** /**
* @brief Enables notifications. * @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. * @note If the notification is already enabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object
@ -168,7 +169,8 @@ void icu_lld_enable_notifications(ICUDriver *icup) {
/** /**
* @brief Disables notifications. * @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. * @note If the notification is already disabled then the call has no effect.
* *
* @param[in] icup pointer to the @p ICUDriver object * @param[in] icup pointer to the @p ICUDriver object