oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

util/StringStrip: more API documentation

Browse Source
This commit is contained in:
Max Kellermann 2018-08-20 16:30:46 +02:00
parent 441440101d
commit 2156fc64f4
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/util/StringStrip.hxx
View File

@ -35,8 +35,10 @@
#include <stddef.h> #include <stddef.h>
/** /**
* Returns a pointer to the first non-whitespace character in the * Skips whitespace at the beginning of the string, and returns the
* string, or to the end of the string. * first non-whitespace character. If the string has no
* non-whitespace characters, then a pointer to the NULL terminator is
* returned.
*/ */
gcc_pure gcc_returns_nonnull gcc_nonnull_all gcc_pure gcc_returns_nonnull gcc_nonnull_all
const char * const char *
@ -49,6 +51,10 @@ StripLeft(char *p) noexcept
return const_cast<char *>(StripLeft((const char *)p)); return const_cast<char *>(StripLeft((const char *)p));
} }
/**
* Skips whitespace at the beginning of the string, and returns the
* first non-whitespace character or the end pointer.
*/
gcc_pure gcc_returns_nonnull gcc_nonnull_all gcc_pure gcc_returns_nonnull gcc_nonnull_all
const char * const char *
StripLeft(const char *p, const char *end) noexcept; StripLeft(const char *p, const char *end) noexcept;