start PIVector doc

This commit is contained in:
Andrey
2022-03-16 16:38:09 +03:00
parent 3e9cb2481c
commit 6e6305d2ec
5 changed files with 99 additions and 226 deletions

View File

@@ -1,7 +1,7 @@
/*! \addtogroup Containers
* \{
* \file picontainers.h
* \~\brief
* \brief
* \~english Base macros for generic containers
* \~russian Базовые макросы для контейнеров
* \~\authors
@@ -47,43 +47,6 @@
#include <new>
#if 0
/*!\brief Macro for iterate any container
* \details Use this macros instead of standard "for"
* to get read/write access to each element of container.
* Pass direction is direct \n
* Example: \snippet picontainers.cpp foreach
*/
# define piForeach(i,c)
/*!\brief Macro for iterate any container only for read
* \details Use this macros instead of standard "for"
* to get read access to each element of container.
* Pass direction is direct \n
* Example: \snippet picontainers.cpp foreachC
*/
# define piForeachC(i,c)
/*!\brief Macro for iterate any container with reverse direction
* \details Use this macros instead of standard "for"
* to get read/write access to each element of container.
* Pass direction is reverse \n
* Example: \snippet picontainers.cpp foreachR
*/
# define piForeachR(i,c)
/*!\brief Macro for iterate any container only for read with reverse direction
* \details Use this macros instead of standard "for"
* to get read access to each element of container.
* Pass direction is reverse \n
* Example: \snippet picontainers.cpp foreachCR
*/
# define piForeachCR(i,c)
#endif
template <typename C>
class _PIReverseWrapper {
public:
@@ -97,6 +60,11 @@ private:
C & c_;
};
/*! \brief
* \~english Template reverse wrapper over any container
* \~russian Шаблонная функция обертки любого контейнера для обратного доступа через итераторы
*/
template <typename C> _PIReverseWrapper<C> PIReverseWrap(C & c) {return _PIReverseWrapper<C>(c);}
template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _PIReverseWrapper<C>(c);}