release 0.3.1

doxygen + refactoring

Inc/modbus_diag.h

@@ -5,7 +5,6 @@
 ******************************************************************************
 @addtogroup MODBUS_DIAG Diagnostics Tools
 @ingroup MODBUS_INTERNAL
-@{
 ******************************************************************************
 * @details
 Модуль реализации Diagnostics (Serial Line only) (0x08):
@@ -13,7 +12,7 @@
 - Возможность выставить/сбросить любой бит в диагностическом регистре
 - Сбор статистики работы устройства
 - Управление режимами работы
-******************************************************************************/
+******************************************  ************************************/
 #ifndef __MODBUS_DIAG_H_
 #define __MODBUS_DIAG_H_ 
 #include "modbus_core.h"
@@ -21,6 +20,11 @@
 /////////////////////////////////////////////////////////////////////
 /////////////////---DEVICE DIAGNOSTICS DEFINES---////////////////////
 
+/**
+  * @addtogroup MODBUS_DIAG
+  * @{
+  */
+  
 /** @brief Режимы работы устройства */
 typedef enum
 {
@@ -57,6 +61,10 @@ extern MB_DiagnosticsInfoTypeDef MB_DIAG;
 /* Инициализация диагностических счетчиков */
 void MB_DiagnosticsInit(void);
 
+/** MODBUS_DIAG
+  * @} 
+  */
+
 /**
   * @addtogroup MODBUS_REQ_DIAG_API API for Diagnostics
   * @ingroup    MODBUS_REQUEST_MSG  
@@ -64,17 +72,20 @@ void MB_DiagnosticsInit(void);
   * @details Примеры использования:
   * 
   * @code
-  * Получить данные диагностики (значение счетчика)
+  * // Получить данные диагностики (значение счетчика)
   * uint16_t counter_value;
-  * if(MB_GetDiagnosticResponse(&MODBUS_MSG, &counter_value))
+  * if(MB_RespGet_Diagnostic(&MODBUS_MSG, &counter_value))
   * {
   *   printf("Counter value: %d\n", counter_value);
   * }
   * @endcode
+  * @{
   */
-int MB_GetDiagnosticResponse(RS_MsgTypeDef *modbus_msg, uint16_t *data);
+  
+int MB_RespGet_Diagnostic(RS_MsgTypeDef *modbus_msg, uint16_t *data);
+
 /** MODBUS_REQ_DIAG_API
-  * @} 
+  * @}
   */
 
 
@@ -95,6 +106,17 @@ int MB_Diagnostics_WriteBit(int bit_num, int bit_state);
 int MB_Diagnostics_GetBit(int bit_num);
 /* Получение текущего режима устройства */
 MB_DeviceModeTypeDef MB_GetDeviceMode(void);
+
+
+/* Функции для обновления счетчиков диагностики */
+void MB_Diagnostics_BusMessageCnt(void);
+void MB_Diagnostics_CommunicationErrorCnt(void);
+void MB_Diagnostics_ExceptionErrorCnt(void);
+void MB_Diagnostics_CharacterOverrunCnt(void);
+void MB_Diagnostics_SlaveMessageCnt(void);
+void MB_Diagnostics_SlaveNoResponseCnt(void);
+void MB_Diagnostics_SlaveNAKCnt(void);
+void MB_Diagnostics_SlaveBusyCnt(void);
 /** MODBUS_CMD_PROCESS_FUNCTIONS
   * @} 
   */
@@ -113,15 +135,6 @@ uint8_t MB_Process_Diagnostics(RS_MsgTypeDef *modbus_msg);
   */
   
   
-/* Функции для обновления счетчиков диагностики */
-void MB_Diagnostics_BusMessageCnt(void);
-void MB_Diagnostics_CommunicationErrorCnt(void);
-void MB_Diagnostics_ExceptionErrorCnt(void);
-void MB_Diagnostics_CharacterOverrunCnt(void);
-void MB_Diagnostics_SlaveMessageCnt(void);
-void MB_Diagnostics_SlaveNoResponseCnt(void);
-void MB_Diagnostics_SlaveNAKCnt(void);
-void MB_Diagnostics_SlaveBusyCnt(void);
 
 
 /////////////////////////---FUNCTIONS---/////////////////////////////