From 8370351ff33208799528417020bc3c6a46307efa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=8B=D1=87=D0=BA=D0=BE=D0=B2=20=D0=90=D0=BD=D0=B4?= =?UTF-8?q?=D1=80=D0=B5=D0=B9?= Date: Wed, 24 Aug 2022 17:33:00 +0300 Subject: [PATCH] add doc to previous commit --- libs/main/containers/pideque.h | 6 ++++++ libs/main/containers/pivector.h | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/libs/main/containers/pideque.h b/libs/main/containers/pideque.h index 0cd57cd5..33f68447 100644 --- a/libs/main/containers/pideque.h +++ b/libs/main/containers/pideque.h @@ -2505,6 +2505,11 @@ public: //! \~english Divides an array into a two-dimensional array using the separator `separator`. //! \~russian Разделяет массив на двумерный массив с помощью разделителя`separator`. + //! \~\code + //! PIDeque v{1, 2, 3, 99, 4, 5, 99, 6}; + //! piCout << v.split(99); // {{1, 2, 3}, {4, 5}, {6}} + //! \endcode + //! \~\sa \a splitBySize() inline PIDeque> split(const T & separator) const { PIDeque> ret; if (isEmpty()) return ret; @@ -2523,6 +2528,7 @@ public: //! \~english Divides an array into a two-dimensional array in chunks of no more than `sz`. //! \~russian Разделяет массив на двумерный массив по кускам не более чем `sz`. + //! \~\sa \a split() inline PIDeque> splitBySize(size_t sz) const { PIDeque> ret; if (isEmpty() || sz == 0) return ret; diff --git a/libs/main/containers/pivector.h b/libs/main/containers/pivector.h index 06bc8543..943cae46 100644 --- a/libs/main/containers/pivector.h +++ b/libs/main/containers/pivector.h @@ -2423,6 +2423,11 @@ public: //! \~english Divides an array into a two-dimensional array using the separator `separator`. //! \~russian Разделяет массив на двумерный массив с помощью разделителя`separator`. + //! \~\code + //! PIVector v{1, 2, 3, 99, 4, 5, 99, 6}; + //! piCout << v.split(99); // {{1, 2, 3}, {4, 5}, {6}} + //! \endcode + //! \~\sa \a splitBySize() inline PIVector> split(const T & separator) const { PIVector> ret; if (isEmpty()) return ret; @@ -2441,6 +2446,7 @@ public: //! \~english Divides an array into a two-dimensional array in chunks of no more than `sz`. //! \~russian Разделяет массив на двумерный массив по кускам не более чем `sz`. + //! \~\sa \a split() inline PIVector> splitBySize(size_t sz) const { PIVector> ret; if (isEmpty() || sz == 0) return ret;