release 0.3.1

doxygen + refactoring

Inc/modbus_devid.h

@@ -5,7 +5,6 @@
 ******************************************************************************
 @addtogroup MODBUS_DEVID Device Identifications Tools
 @ingroup MODBUS_INTERNAL
-@{
 ******************************************************************************
 * @details
 Модуль реализации функции Read Device Identifications (0x2B):
@@ -13,7 +12,7 @@
 - Расширенная идентификация (URL, Model, User fields)
 - Поддержка потоковой передачи больших объектов
 
-@section Объекты идентификации:
+@section  Объекты идентификации:
 - VendorName, ProductCode, Revision - обязательные
 - VendorUrl, ProductName, ModelName - опциональные
 - User objects - пользовательские поля
@@ -27,6 +26,11 @@
 /////////////////////////////////////////////////////////////////////
 ///////////////---DEVICE IDENTIVICATIONS DEFINES---//////////////////
 
+/**
+  * @addtogroup MODBUS_DEVID
+  * @{
+  */
+  
 /** @brief Структура для объекта (идентификатора устройства модбас) */
 typedef struct
 {
@@ -61,15 +65,20 @@ void MB_DeviceInentificationInit(void);
   * @brief    Инициализация объектов
   * @details  С помозью этого дефайна инициализируются объекты в @ref MB_DeviceInentificationInit
   */
-#define MB_ObjectInit(_p_obj_, _userstring_)    (_p_obj_)->length  = sizeof(_userstring_);\
-                                                (_p_obj_)->name    = _userstring_;
-                                                        /**
+#define MB_ObjectInit(_p_obj_, _userstring_) \
+(_p_obj_)->length  = sizeof(_userstring_);\
+(_p_obj_)->name    = _userstring_;
+/**
   * @brief    Инициализация пользовательских объектов
   * @details  С помозью этого дефайна инициализируются пользовательские объекты в MB_DeviceInentificationInit
   */
 #define MB_UserObjectInit(_pinfostruct_, _user_numb_)   MB_ObjectInit(&(_pinfostruct_)->User[_user_numb_], MODBUS_USEROBJECT##_user_numb_##_NAME)
 
 
+    
+/** MODBUS_DEVID
+* @} 
+*/
 ////////////////////---MODBUS MESSAGE DEFINES---/////////////////////
 
 
@@ -80,14 +89,14 @@ void MB_DeviceInentificationInit(void);
 /**
   * @addtogroup MODBUS_REQ_DEFID_API API for Device Identifications
   * @ingroup    MODBUS_REQUEST_MSG
-  * @brief Макросы для чтения идентификторов из ответа в режиме мастер
+  * @brief API для чтения идентификторов из ответа в режиме мастер
   * @details Примеры использования:
   * 
   * @code
   * // Пример 1: Получить VendorName (ID = 0x00)
   * uint8_t length;
   * char vendor_name[64];
-  * if(MB_FindObjectById(&MODBUS_MSG, 0x00, vendor_name, &length))
+  * if(MB_RespGet_ObjectById(&MODBUS_MSG, 0x00, vendor_name, &length))
   * {
   *   // получено
   * }
@@ -96,25 +105,26 @@ void MB_DeviceInentificationInit(void);
   * uint8_t obj_id, obj_length;
   * char obj_data[256];
   * 
-  * int obj_count = MB_GetNumberOfObjects(&MODBUS_MSG);
+  * int obj_count = MB_RespGet_NumberOfObjects(&MODBUS_MSG);
   * printf("Total objects: %d\n", obj_count);
   * 
   * for(int i = 0; i < obj_count; i++)
   * {
-  *   if(MB_GetObjectByIndex(&MODBUS_MSG, i, &obj_id, obj_data, &obj_length))
+  *   if(MB_RespGet_ObjectByIndex(&MODBUS_MSG, i, &obj_id, obj_data, &obj_length))
   *   {
   *     // получено
   *   }
   * }
   * @endcode
+  * @{
   */
   
 /* Получить количество объектов в сообщении */
-int MB_GetNumberOfObjects(RS_MsgTypeDef *modbus_msg);
+int MB_RespGet_NumberOfObjects(RS_MsgTypeDef *modbus_msg);
 /* Найти объект по ID в сообщении */
-int MB_FindObjectById(RS_MsgTypeDef *modbus_msg, uint8_t obj_id, char *obj_data, uint8_t *obj_length);
+int MB_RespGet_ObjectById(RS_MsgTypeDef *modbus_msg, uint8_t obj_id, char *obj_data, uint8_t *obj_length);
 /* Получить объект по индексу в сообщении */
-int MB_GetObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_id, char *obj_data, uint8_t *obj_length);
+int MB_RespGet_ObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_id, char *obj_data, uint8_t *obj_length);
 
     
 /** MODBUS_REQ_DEFID_API
@@ -122,12 +132,19 @@ int MB_GetObjectByIndex(RS_MsgTypeDef *modbus_msg, int index, uint8_t *obj_id, c
 */
   
   
+/**
+  * @addtogroup MODBUS_DEVID
+  * @{
+  */
   
 /* Записать Один Объект Идентификатора в массив данных */
 void MB_WriteSingleObjectToMessage(char *mbdata, unsigned *ind, MB_DeviceObjectTypeDef *obj);
 /* Записать Массив Объектов Идентификатора в массив данных */
 void MB_WriteObjectsToMessage(RS_MsgTypeDef *modbus_msg, unsigned maxidofobj);
 
+/** MODBUS_DEVID
+  * @} 
+  */
 //---------PROCESS MODBUS COMMAND FUNCTIONS---------
 /** 
   * @addtogroup MODBUS_CMD_PROCESS_FUNCTIONS
@@ -142,7 +159,3 @@ uint8_t MB_Process_Read_Device_Identifications(RS_MsgTypeDef *modbus_msg);
 /////////////////////////---FUNCTIONS---/////////////////////////////
 
 #endif //__MODBUS_DEVID_H_
-
-/** MODBUS_DEVID
-  * @} 
-  */