picontainers.h doxygen fixes, generating html/pip.cfg

This commit is contained in:
Andrey
2022-03-14 18:17:16 +03:00
parent 99280a40ef
commit 9bf1a11701
2 changed files with 9 additions and 13 deletions

View File

@@ -2209,7 +2209,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = doc/pip.cfg
GENERATE_TAGFILE = html/pip.cfg
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be

View File

@@ -1,9 +1,8 @@
/*! \file picontainers.h
* \brief
* \~\brief
* \~english Base macros for generic containers
* \~russian Базовые макросы для контейнеров
*
* \authors
* \~\authors
* \~english
* Ivan Pelipenko peri4ko@yandex.ru;
* Andrey Bychkov work.a.b@yandex.ru;
@@ -80,7 +79,7 @@
*/
# define piForeachCR(i,c)
#else
#endif
template <typename C>
@@ -103,7 +102,7 @@ template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _P
/*! \brief
* \~english Macro for short replacement of standart "for"
* \~russian Макрос для короткой записи стандартного цикла "for"
* \param c
* \~\param c
* \~english Iteration times in loop
* \~russian Количество итераций цикла
*/
@@ -113,17 +112,17 @@ template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _P
/*! \brief
* \~english Macro for iterate any container
* \~russian Макрос для перебора любых контейнеров
* \deprecated
* \~\deprecated
* \~english Deprecated, using only for backward compatibility. Use "c++ range for".
* \~russian Устарело, используется только для обратной совместимости. Используйте "c++ range for".
* \details
* \~\details
* \~english Get read/write access to each element of container.
* Iterating in forward direction.
* Example of using:
* \~russian Перебор всех элементов контейнера с доступом на чтение и запись.
* Перебор осуществляется в прямом порядке.
* Пример использования:
* \code
* \~\code
* PIVector<int> vec;
* vec << 1 << 2 << 3;
* piForeach(int & i, vec) piCout << i;
@@ -142,10 +141,7 @@ template <typename C> _PIReverseWrapper<C> PIReverseWrap(const C & c) {return _P
#define piForeachC(i, c) for(const i : c)
#define piForeachR(i, c) for(i : PIReverseWrap(c))
#define piForeachRC(i, c) for(const i : PIReverseWrap(c))
# define piForeachCR piForeachRC
#endif // DOXYGEN
#define piForeachCR piForeachRC
#endif // PICONTAINERS_H