picontainers.h doxygen partial

libs/main/core/pibase.h

@@ -1,4 +1,4 @@
-/*! @file pibase.h
+/*! \file pibase.h
  * \brief
  * \~english Base types and functions
  * \~russian Базовые типы и методы
@@ -83,40 +83,45 @@
 #  define PIP_DEBUG
 
 //! \brief
-//! \~english Macro is defined when host is any Windows
-//! \~russian Макрос объявлен когда система Windows
+//! \~english Macro is defined when operation system is any Windows
+//! \~russian Макрос объявлен когда операционная система Windows
 #  define WINDOWS
 
 //! \brief
-//! \~english Macro is defined when host is QNX or Blackberry
-//! \~russian Макрос объявлен когда система QNX или Blackberry
+//! \~english Macro is defined when operation system is QNX or Blackberry
+//! \~russian Макрос объявлен когда операционная система QNX или Blackberry
 #  define QNX
 
 //! \brief
-//! \~english Macro is defined when host is Blackberry
-//! \~russian Макрос объявлен когда система Blackberry
+//! \~english Macro is defined when operation system is Blackberry
+//! \~russian Макрос объявлен когда операционная система Blackberry
 #  define BLACKBERRY
 
 //! \brief
-//! \~english Macro is defined when host is FreeBSD
-//! \~russian Макрос объявлен когда система FreeBSD
+//! \~english Macro is defined when operation system is FreeBSD
+//! \~russian Макрос объявлен когда операционная система FreeBSD
 #  define FREE_BSD
 
 //! \brief
-//! \~english Macro is defined when host is Mac OS
-//! \~russian Макрос объявлен когда система Mac OS
+//! \~english Macro is defined when operation system is Mac OS
+//! \~russian Макрос объявлен когда операционная система Mac OS
 #  define MAC_OS
 
 //! \brief
-//! \~english Macro is defined when host is Android
-//! \~russian Макрос объявлен когда система Android
+//! \~english Macro is defined when operation system is Android
+//! \~russian Макрос объявлен когда операционная система Android
 #  define ANDROID
 
 //! \brief
-//! \~english Macro is defined when host is any Linux
-//! \~russian Макрос объявлен когда система Linux
+//! \~english Macro is defined when operation system is any Linux
+//! \~russian Макрос объявлен когда операционная система Linux
 #  define LINUX
 
+//! \brief
+//! \~english Macro is defined when operation system is FreeRTOS
+//! \~russian Макрос объявлен когда операционная система FreeRTOS
+#  define FREERTOS
+
 //! \brief
 //! \~english Macro is defined when compiler is GCC or MinGW
 //! \~russian Макрос объявлен когда компилятор GCC или MinGW
@@ -127,19 +132,29 @@
 //! \~russian Макрос объявлен когда PIP решил что система поддерживает локализацию
 #  define HAS_LOCALE
 
+//! \brief
+//! \~english Macro is defined when PIP is building for embedded systems
+//! \~russian Макрос объявлен когда PIP собирается для встраиваемых систем
+#  define MICRO_PIP
+
 //! \brief
 //! \~english Macro is defined when compiler is Visual Studio
 //! \~russian Макрос объявлен когда компилятор Visual Studio
 #  define CC_VC
 
+//! \brief
+//! \~english Macro is defined when compiler is AVR GCC
+//! \~russian Макрос объявлен когда компилятор AVR GCC
+#  define CC_AVR_GCC
+
 //! \brief
 //! \~english Macro is defined when compiler is unknown
 //! \~russian Макрос объявлен когда компилятор неизвестен
 #  define CC_OTHER
 
 //! \brief
-//! \~english Macro is defined when PIP can use "rt" library for "PITimer::ThreadRT" timers implementation
-//! \~russian Макрос объявлен когда PIP может использовать библиотеку "rt" для "PITimer::ThreadRT" реализации таймера
+//! \~english Macro is defined when PIP can use "rt" library for \a PITimer::ThreadRT timers implementation
+//! \~russian Макрос объявлен когда PIP может использовать библиотеку "rt" для \a PITimer::ThreadRT реализации таймера
 #  define PIP_TIMER_RT
 
 //! \brief
@@ -177,7 +192,8 @@
 //! \~russian Макрос для окончания статической инициализации
 #  define STATIC_INITIALIZER_END
 
-
+#undef MICRO_PIP
+#undef FREERTOS
 #endif //DOXYGEN
 
 #ifdef CC_AVR_GCC
@@ -343,10 +359,18 @@
 } _PIP_ADD_COUNTER(_pip_initializer_);
 
 
-#ifdef MICRO_PIP
-#  define PIP_MIN_MSLEEP 10.
-#else
-#  define PIP_MIN_MSLEEP 1.
+//! \brief
+//! \~english Minimal sleep in milliseconds for internal PIP using
+//! \~russian Минимальное значание задержки в милисекундах для внутреннего использования в библиотеке PIP
+//! \details
+//! \~english Using in \a piMinSleep(), \a PIThread, \a PITimer::Pool. By default 1ms.
+//! \~russian Используется в \a piMinSleep(), \a PIThread, \a PITimer::Pool. По умолчанию равна 1мс.
+#ifndef PIP_MIN_MSLEEP
+#  ifndef MICRO_PIP
+#    define PIP_MIN_MSLEEP 1.
+#  else
+#    define PIP_MIN_MSLEEP 10.
+#  endif
 #endif