From 203679bf32357b6bee05399ac9051ddac04c1ed5 Mon Sep 17 00:00:00 2001 From: Martchus Date: Sat, 24 Jul 2021 23:38:12 +0200 Subject: [PATCH] Document that delimiter for splitString*() must not be empty --- conversion/stringconversion.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conversion/stringconversion.h b/conversion/stringconversion.h index 2719fcd..8d72d72 100644 --- a/conversion/stringconversion.h +++ b/conversion/stringconversion.h @@ -150,7 +150,7 @@ enum class EmptyPartsTreat { /*! * \brief Splits the given \a string at the specified \a delimiter. * \param string The string to be split. - * \param delimiter Specifies the delimiter. + * \param delimiter Specifies the delimiter which must not be empty. * \param emptyPartsRole Specifies the treatment of empty parts. * \param maxParts Specifies the maximal number of parts. Values less or equal zero indicate an unlimited number of parts. * \tparam Container The STL-container used to return the parts. @@ -202,7 +202,7 @@ Container splitString(Detail::StringParamForContainer string, Detail: /*! * \brief Splits the given \a string (which might also be a string view) at the specified \a delimiter. * \param string The string to be split. - * \param delimiter Specifies the delimiter. + * \param delimiter Specifies the delimiter which must not be empty. * \param maxParts Specifies the maximal number of parts. Values less or equal zero indicate an unlimited number of parts. * \tparam Container The STL-container used to return the parts. * \returns Returns the parts.