From ea624f1223860792b0a7183634b666e0835dd9b1 Mon Sep 17 00:00:00 2001
From: Andrey <a.bychkov@itelma.su>
Date: Tue, 15 Mar 2022 15:34:45 +0300
Subject: [PATCH] picontainers.h doc

---
 libs/main/containers/picontainers.h       | 50 ++++++++++++++++++++++-
 libs/main/containers/picontainersmodule.h |  7 ++--
 2 files changed, 52 insertions(+), 5 deletions(-)

diff --git a/libs/main/containers/picontainers.h b/libs/main/containers/picontainers.h
index 6a126e25..71c2af59 100644
--- a/libs/main/containers/picontainers.h
+++ b/libs/main/containers/picontainers.h
@@ -115,8 +115,9 @@ template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _P
  * \~english Macro for iterate any container
  * \~russian Макрос для перебора любых контейнеров
  * \~\deprecated
- * \~english Deprecated, using only for backward compatibility. Use "c++ range for".
- * \~russian Устарело, используется только для обратной совместимости. Используйте "c++ range for".
+ * \~english Deprecated, using only for backward compatibility. Use
+ * \~russian Устарело, используется только для обратной совместимости. Используйте
+ * \~ [C++ Range-based for loop](https://en.cppreference.com/w/cpp/language/range-for).
  * \~\details
  * \~english Get read/write access to each element of container.
  * Iterating in forward direction.
@@ -137,11 +138,56 @@ template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _P
  * // 3
  * // 4
  * \endcode
+ * \sa \a piForeachC, \a piForeachR, \a piForeachRC
  */
 #define piForeach(i, c) for(i : c)
 
+/*! \brief
+ * \~english Macro for iterate any container
+ * \~russian Макрос для перебора любых контейнеров
+ * \~\deprecated
+ * \~english Deprecated, using only for backward compatibility. Use
+ * \~russian Устарело, используется только для обратной совместимости. Используйте
+ * \~ [C++ Range-based for loop](https://en.cppreference.com/w/cpp/language/range-for).
+ * \~\details
+ * \~english Get read only access to each element of container.
+ * Iterating in forward direction.
+ * \~russian Перебор всех элементов контейнера с доступом только на чтение.
+ * Перебор осуществляется в прямом порядке.
+ * \~ \sa \a piForeach, \a piForeachR, \a piForeachRC
+ */
 #define piForeachC(i, c) for(const i : c)
+
+/*! \brief
+ * \~english Macro for iterate any container
+ * \~russian Макрос для перебора любых контейнеров
+ * \~\deprecated
+ * \~english Deprecated, using only for backward compatibility. Use
+ * \~russian Устарело, используется только для обратной совместимости. Используйте
+ * \~ [C++ Range-based for loop](https://en.cppreference.com/w/cpp/language/range-for).
+ * \~\details
+ * \~english Get read/write access to each element of container.
+ * Iterating in backward direction.
+ * \~russian Перебор всех элементов контейнера с доступом на чтение и запись.
+ * Перебор осуществляется в обратном порядке.
+ * \~ \sa \a piForeach, \a piForeachC, \a piForeachRC
+ */
 #define piForeachR(i, c) for(i : PIReverseWrap(c))
+
+/*! \brief
+ * \~english Macro for iterate any container
+ * \~russian Макрос для перебора любых контейнеров
+ * \~\deprecated
+ * \~english Deprecated, using only for backward compatibility. Use
+ * \~russian Устарело, используется только для обратной совместимости. Используйте
+ * \~ [C++ Range-based for loop](https://en.cppreference.com/w/cpp/language/range-for).
+ * \~\details
+ * \~english Get read only access to each element of container.
+ * Iterating in backward direction. Also has alias **piForeachCR**
+ * \~russian Перебор всех элементов контейнера с доступом только на чтение.
+ * Перебор осуществляется в обратном порядке. Также можно писать **piForeachCR**
+ * \~ \sa \a piForeach, \a piForeachC, \a piForeachR
+ */
 #define piForeachRC(i, c) for(const i : PIReverseWrap(c))
 #define piForeachCR piForeachRC
 
diff --git a/libs/main/containers/picontainersmodule.h b/libs/main/containers/picontainersmodule.h
index 2f04c2c6..b1682e2f 100644
--- a/libs/main/containers/picontainersmodule.h
+++ b/libs/main/containers/picontainersmodule.h
@@ -18,10 +18,11 @@
 */
 /** \defgroup Containers
  * \~\brief
- * \~english This module contains various standart containers realization.
- * This includes
+ * This module contains various standart containers realization.
  * \~russian Модуль содержит основные классы контейнеров.
- * В него входят
+ * \~\details
+ * \~english This includes
+ * \~russian В него входят
  * \~ \a PIVector, \a PIDeque, \a PIMap, \a PISet,
  *  \a PIStack, \a PIQueue, \a PIVector2D.
  *