diff options
Diffstat (limited to 'src/wcstringutil.h')
| -rw-r--r-- | src/wcstringutil.h | 31 |
1 files changed, 13 insertions, 18 deletions
diff --git a/src/wcstringutil.h b/src/wcstringutil.h index d2feec07..ea4489e7 100644 --- a/src/wcstringutil.h +++ b/src/wcstringutil.h @@ -1,7 +1,4 @@ -/** \file wcstringutil.h - -Helper functions for working with wcstring -*/ +// Helper functions for working with wcstring. #ifndef FISH_WCSTRINGUTIL_H #define FISH_WCSTRINGUTIL_H @@ -10,21 +7,19 @@ Helper functions for working with wcstring #include "common.h" -/** - typedef that represents a range in a wcstring. - The first element is the location, the second is the count. -*/ +/// Typedef that represents a range in a wcstring. The first element is the location, the second is +/// the count. typedef std::pair<wcstring::size_type, wcstring::size_type> wcstring_range; -/** - wcstring equivalent of wcstok(). Supports NUL. - For convenience and wcstok() compatibility, the first character of each - token separator is replaced with NUL. - Returns a pair of (pos, count). - Returns (npos, npos) when it's done. - Returns (pos, npos) when the token is already known to be the final token. - Note that the final token may not necessarily return (pos, npos). -*/ -wcstring_range wcstring_tok(wcstring& str, const wcstring &needle, wcstring_range last = wcstring_range(0,0)); +/// wcstring equivalent of wcstok(). Supports NUL. For convenience and wcstok() compatibility, the +/// first character of each token separator is replaced with NUL. +/// +/// Returns a pair of (pos, count). +/// Returns (npos, npos) when it's done. +/// Returns (pos, npos) when the token is already known to be the final token. +/// +/// Note that the final token may not necessarily return (pos, npos). +wcstring_range wcstring_tok(wcstring& str, const wcstring& needle, + wcstring_range last = wcstring_range(0, 0)); #endif |