Коррекции по синтаксису и doxygen
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
* @file modbus_data.h
|
||||
* @brief Определения структур данных Modbus устройства
|
||||
******************************************************************************
|
||||
@defgroup MODBUS_DATA Modbus Data Tools
|
||||
@defgroup MODBUS_DATA Modbus Registers Map
|
||||
@ingroup MODBUS
|
||||
@brief Определение карты регистров и коилов
|
||||
******************************************************************************
|
||||
@@ -13,7 +13,7 @@
|
||||
- Input Registers (R/O) - входные регистры
|
||||
- Coils (R/W) - дискретные выходы
|
||||
|
||||
@section Базовая настройка под устройство:
|
||||
@section datinit Базовая настройка под устройство:
|
||||
1. Настроить диапазоны адресов
|
||||
- @ref R_INPUT_ADDR и @ref R_INPUT_QNT для входных регистров
|
||||
- @ref R_HOLDING_ADDR и @ref R_HOLDING_QNT для регистров хранения
|
||||
@@ -24,7 +24,7 @@
|
||||
- @ref MB_DataCoilsTypeDef
|
||||
|
||||
|
||||
@section Расширенная настройка под устройство:
|
||||
@section datexpert Расширенная настройка под устройство:
|
||||
1. Добавить новый массив с нужными данными.
|
||||
2. Добавить дефайны для определения его начального адреса и количества элементов
|
||||
3. Добавить проверку адресов в MB_DefineRegistersAddress/MB_DefineCoilsAddress.
|
||||
@@ -75,11 +75,11 @@
|
||||
* @addtogroup MODBUS_DATA_RERISTERS_DEFINES Registers structures
|
||||
* @ingroup MODBUS_DATA
|
||||
* @brief Стуруктура регистров (входных и хранения)
|
||||
@verbatim
|
||||
@code
|
||||
Для массивов регистров:
|
||||
R_<NAME_ARRAY>_ADDR - модбас адресс первого регистра в массиве
|
||||
R_<NAME_ARRAY>_QNT - количество регистров в массиве
|
||||
@endverbatim
|
||||
@endcode
|
||||
* @{
|
||||
*/
|
||||
|
||||
@@ -111,12 +111,12 @@ typedef struct //MB_DataInRegsTypeDef
|
||||
* @addtogroup MODBUS_DATA_COILS_DEFINES Coils Structure
|
||||
* @ingroup MODBUS_DATA
|
||||
* @brief Структура коилов
|
||||
@verbatim
|
||||
@code
|
||||
Структура дефайна
|
||||
Для массивов коилов:
|
||||
C_<NAME_ARRAY>_ADDR - модбас адресс первого коила в массиве
|
||||
C_<NAME_ARRAY>_QNT - количество коилов в массиве (минимум 16)
|
||||
@endverbatim
|
||||
@endcode
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user