Рефакторинг Doxygen

This commit is contained in:
2025-11-07 20:26:38 +03:00
parent 0cc8f417ee
commit 3718c1eb77
363 changed files with 16172 additions and 6104 deletions

View File

@@ -4,7 +4,6 @@
* @brief Заголовочный файл для измерения времени между событиями
******************************************************************************
* @addtogroup BENCH_TIME Time measurement
* @ingroup MYLIBS_DEFINES
* @brief Библиотека для измерения времени/тиков между событиями
* @details
Поддерживает:

View File

@@ -4,7 +4,7 @@
* @brief Заголочный файл для дефайнов битового доступа.
**************************************************************************
* @defgroup BIT_ACCESS_DEFINES Bit access defines
* @ingroup MYLIBS_DEFINES
* @ingroup MYLIBS_TOOLS
* @brief Макросы и typedef'ы для работы с битами в unsigned типах.
* @details
В этом файле определены макросы для получения значения конкретного бита^

View File

@@ -4,7 +4,6 @@
* @brief Заголовочный файл для адаптивного подбора параметров
******************************************************************************
* @addtogroup GEN_OPTIMIZER Genetic optimizer
* @ingroup MYLIBS_DEFINES
* @brief Библиотека для эволюционного подбора параметров
* @details
Поддерживает:

View File

@@ -3,13 +3,28 @@
* @file mylibs_defs.h
* @brief Заголочный файл для дефайнов библиотеки MyLibsGeneral.
**************************************************************************
* @defgroup MYLIBS_DEFINES General Tools
* @defgroup MYLIBS_TOOLS General Tools
* @ingroup MYLIBS_ALL
* @brief Общие макросы и typedef'ы, используемые по всему проекту
*
* @defgroup MYLIBS_DEBUG_TOOLS Debug Tools
* @ingroup MYLIBS_ALL
* @brief Утилиты для тестирования программы
*
* @addtogroup BENCH_TIME
* @ingroup MYLIBS_DEBUG_TOOLS
*
* @addtogroup GEN_OPTIMIZER
* @ingroup MYLIBS_DEBUG_TOOLS
*
* @addtogroup TRACE
* @ingroup MYLIBS_DEBUG_TOOLS
*
* @addtogroup TRACKERS
* @ingroup MYLIBS_DEBUG_TOOLS
*************************************************************************/
#ifndef __MYLIBS_DEFINES_H_
#define __MYLIBS_DEFINES_H_
#ifndef __MYLIBS_TOOLS_H_
#define __MYLIBS_TOOLS_H_
#include "mylibs_config.h"
@@ -17,7 +32,7 @@
******************************ERROR_HANDLER********************************/
/**
* @addtogroup ERROR_HANDLER_DEFINES Error Handler defines
* @ingroup MYLIBS_DEFINES
* @ingroup MYLIBS_TOOLS
* @brief Дефайны для обработки ошибок
* @{
*/
@@ -58,7 +73,7 @@ extern void Error_Handler(void);
******************************DELAYS_DEFINES*******************************/
/**
* @addtogroup DELAYS_DEFINES Delays defines
* @ingroup MYLIBS_DEFINES
* @ingroup MYLIBS_TOOLS
* @brief Макросы и определения для работы с задержками в миллисекундах.
* @details
* Этот блок содержит макросы для реализации задержек с использованием HAL или FreeRTOS:
@@ -140,7 +155,7 @@ extern void Error_Handler(void);
*******************************UTIL_DEFINES********************************/
/**
* @addtogroup UTILS_DEFINES Utils defines
* @ingroup MYLIBS_DEFINES
* @ingroup MYLIBS_TOOLS
* @brief Общие вспомогательные макросы
* @{
*/
@@ -203,4 +218,4 @@ do{ \
/** @endcond */
#endif //__MYLIBS_DEFINES_H_
#endif //__MYLIBS_TOOLS_H_

View File

@@ -14,13 +14,8 @@
- Сконфигурировать mylibs_config.h:
- Подключить заголовочный файл HAL библиотеки конкретного МК (напр. stm32f4xx_hal.h)
- Подключить другие заголовочные файлы которые общие для всего проекта и должны быть видны
-
- Подключить mylibs_include.h туда, где необходим доступ к библиотекам.
- Подключить mylibs_include.h туда, где необходим доступ к библиотекам.
* @defgroup MYLIBS_PERIPHERAL Peripheral
* @ingroup MYLIBS_ALL
* @brief Модули для управления периферией
*
*************************************************************************/
#ifndef __MYLIBS_INCLUDE_H_
#define __MYLIBS_INCLUDE_H_

View File

@@ -4,7 +4,6 @@
* @brief Заголочный файл для работы с трассировкой.
**************************************************************************
* @addtogroup TRACE Trace defines
* @ingroup MYLIBS_DEFINES
* @brief Дефайны для работы с трассировкой
*************************************************************************/
#ifndef __TRACE_H_

View File

@@ -4,7 +4,6 @@
* @brief Заголочный файл для работы с трекерами @ref TRACKERS.
**************************************************************************
* @addtogroup TRACKERS Trackers defines
* @ingroup MYLIBS_DEFINES
* @brief Дефайны для работы с трекерами
* @details
Есть дефайн для объявления структуры трекера: TrackerTypeDef(num_user_vars).