Commit ff884b61 authored by Tudor Bosman's avatar Tudor Bosman

Clarify split / splitTo comments.

Test Plan: No

Reviewed By: delong.j@fb.com

FB internal diff: D494525
parent 6834f1d6
...@@ -283,13 +283,14 @@ inline fbstring exceptionStr(const std::exception& e) { ...@@ -283,13 +283,14 @@ inline fbstring exceptionStr(const std::exception& e) {
* The split interface here supports different output types, selected * The split interface here supports different output types, selected
* at compile time: StringPiece, fbstring, or std::string. If you are * at compile time: StringPiece, fbstring, or std::string. If you are
* using a vector to hold the output, it detects the type based on * using a vector to hold the output, it detects the type based on
* what your vector contains. * what your vector contains. If the output vector is not empty, split
* will append to the end of the vector.
* *
* You can also use splitTo() to write the output to an arbitrary * You can also use splitTo() to write the output to an arbitrary
* OutputIterator (e.g. std::inserter() on a std::set<>), in which * OutputIterator (e.g. std::inserter() on a std::set<>), in which
* case you have to tell the function the type. (Rationale: * case you have to tell the function the type. (Rationale:
* OutputIterators don't have a value_type, so we can't detect the * OutputIterators don't have a value_type, so we can't detect the
* type in split without being told.) * type in splitTo without being told.)
* *
* Examples: * Examples:
* *
...@@ -300,9 +301,9 @@ inline fbstring exceptionStr(const std::exception& e) { ...@@ -300,9 +301,9 @@ inline fbstring exceptionStr(const std::exception& e) {
* folly::splitTo<StringPiece>(":", "asd:bsd:asd:csd", * folly::splitTo<StringPiece>(":", "asd:bsd:asd:csd",
* std::inserter(s, s.begin())); * std::inserter(s, s.begin()));
* *
* Split also takes a flag (ignoreEmpty) that indicates whether * Split also takes a flag (ignoreEmpty) that indicates whether adjacent
* adjacent tokens should be treated as one separator or not. Note * delimiters should be treated as one single separator (ignoring empty tokens)
* that unlikely strtok() the default is to treat them as separators. * or not (generating empty tokens).
*/ */
template<class Delim, class String, class OutputType> template<class Delim, class String, class OutputType>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment