Доработал модуль TIM (с точки зрения документции. Код не проверен)
Доработна документация в целом - добавелн main page - исправлены ошибки в шапках и коментах - добавлен граф инклюдов
This commit is contained in:
@@ -6,49 +6,50 @@
|
||||
* @addtogroup TRACKERS Trackers defines
|
||||
* @ingroup MYLIBS_DEFINES
|
||||
* @brief Дефайны для работы с трекерами
|
||||
* @details Есть дефайн для объявления структуры трекера: TrackerTypeDef(num_user_vars).
|
||||
Структура состоит из следующих элементов:
|
||||
- cnt_ok
|
||||
- cnt_err
|
||||
- cnt_warn
|
||||
- user[num_user_vars]
|
||||
Также есть ряд функций (дефайнов) для обращения к элементам этой структуры.
|
||||
|
||||
|
||||
Если трекеры @ref TRACKERS_ENABLE отключены, то все дефайны определяются как ничего
|
||||
и на производительность кода не влияют
|
||||
|
||||
@par Пример:
|
||||
|
||||
Определяем typedef трекера измерений Measure_TrackerTypeDef
|
||||
* @details
|
||||
Есть дефайн для объявления структуры трекера: TrackerTypeDef(num_user_vars).
|
||||
Структура состоит из следующих элементов:
|
||||
- cnt_ok
|
||||
- cnt_err
|
||||
- cnt_warn
|
||||
- user[num_user_vars]
|
||||
Также есть ряд функций (дефайнов) для обращения к элементам этой структуры.
|
||||
|
||||
@verbatim
|
||||
typedef TrackerTypeDef(MEASURE_USER_VARS_NUMB) Measure_TrackerTypeDef;
|
||||
@endverbatim
|
||||
|
||||
И через @ref Measure_TrackerTypeDef структура подключается в другие структуры
|
||||
Если трекеры @ref TRACKERS_ENABLE отключены, то все дефайны определяются как ничего
|
||||
и на производительность кода не влияют
|
||||
|
||||
@par Пример:
|
||||
|
||||
Определяем typedef трекера измерений Measure_TrackerTypeDef
|
||||
|
||||
@verbatim
|
||||
typedef TrackerTypeDef(MEASURE_USER_VARS_NUMB) Measure_TrackerTypeDef;
|
||||
@endverbatim
|
||||
|
||||
И через @ref Measure_TrackerTypeDef структура подключается в другие структуры
|
||||
|
||||
Для работы с структурой можно использовать функции:
|
||||
- Для получения значения:
|
||||
- TrackerGet_Ok()
|
||||
- TrackerGet_Err()
|
||||
- TrackerGet_Warn()
|
||||
- TrackerGet_User(n)
|
||||
|
||||
Для работы с структурой можно использовать функции:
|
||||
- Для получения значения:
|
||||
- TrackerGet_Ok()
|
||||
- TrackerGet_Err()
|
||||
- TrackerGet_Warn()
|
||||
- TrackerGet_User(n)
|
||||
|
||||
- Для записи значения:
|
||||
- TrackerCnt_Ok()
|
||||
- TrackerCnt_Err()
|
||||
- TrackerCnt_Warn()
|
||||
- TrackerCnt_User()
|
||||
- TrackerWrite_User(n)
|
||||
|
||||
- Для очищения значения:
|
||||
- TrackerClear_All()
|
||||
- TrackerClear_Ok()
|
||||
- TrackerClear_Err()
|
||||
- TrackerClear_Warn()
|
||||
- TrackerClear_User(n)
|
||||
- TrackerClear_UserAll()
|
||||
- Для записи значения:
|
||||
- TrackerCnt_Ok()
|
||||
- TrackerCnt_Err()
|
||||
- TrackerCnt_Warn()
|
||||
- TrackerCnt_User()
|
||||
- TrackerWrite_User(n)
|
||||
|
||||
- Для очищения значения:
|
||||
- TrackerClear_All()
|
||||
- TrackerClear_Ok()
|
||||
- TrackerClear_Err()
|
||||
- TrackerClear_Warn()
|
||||
- TrackerClear_User(n)
|
||||
- TrackerClear_UserAll()
|
||||
* @{
|
||||
*************************************************************************/
|
||||
#ifndef __TRACKERS_H_
|
||||
|
||||
Reference in New Issue
Block a user