Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for rcpputils::split functions #188

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Update docs for rcpputils::split functions #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions include/rcpputils/split.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,10 @@ namespace rcpputils
/// @cond
/// Split a specified input into tokens using a delimiter and a type erased insert iterator.
/**
* The returned vector will contain the tokens split from the input
*
* \param[in] input the input string to be split
* \param[in] delim the delimiter used to split the input string
* \param[in] it iterator pointing to a storage container
* \param[in] skip_empty remove empty strings from the return vector
* \param[in] it an insert iterator pointing to a storage container
* \param[in] skip_empty skip empty strings when inserting tokens
*/
template<
class InsertIterator,
Expand Down Expand Up @@ -82,7 +80,7 @@ split(const std::string & input, char delim, InsertIterator & it, bool skip_empt
*
* \param[in] input the input string to be split
* \param[in] delim the delimiter used to split the input string
* \param[in] skip_empty remove empty strings from the return vector
* \param[in] skip_empty remove empty strings from the returned vector
* \return A vector of tokens.
*/
inline std::vector<std::string>
Expand Down