caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

gmio_core: more doc in string_parse.h

Browse Source
This commit is contained in:
Hugues Delorme 2015-05-26 18:25:14 +02:00
parent e79341ec26
commit cad2a28f65
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/gmio_core/internal/string_parse.h
View File

@ -65,19 +65,27 @@ struct gmio_string_stream_fwd_iterator
typedef struct gmio_string_stream_fwd_iterator typedef struct gmio_string_stream_fwd_iterator
gmio_string_stream_fwd_iterator_t; gmio_string_stream_fwd_iterator_t;
/*! Initializes iterator */
void gmio_string_stream_fwd_iterator_init( void gmio_string_stream_fwd_iterator_init(
gmio_string_stream_fwd_iterator_t* it); gmio_string_stream_fwd_iterator_t* it);
/*! Returns the char where the iterator is currently pointing at */
GMIO_INLINE const char* gmio_current_char( GMIO_INLINE const char* gmio_current_char(
const gmio_string_stream_fwd_iterator_t* it); const gmio_string_stream_fwd_iterator_t* it);
/*! Move on next char in stream */ /*! Moves on next char in stream */
GMIO_INLINE const char *gmio_next_char( GMIO_INLINE const char *gmio_next_char(
gmio_string_stream_fwd_iterator_t *it); gmio_string_stream_fwd_iterator_t *it);
/*! Advances iterator until the next non-space char */
GMIO_INLINE const char* gmio_skip_spaces( GMIO_INLINE const char* gmio_skip_spaces(
gmio_string_stream_fwd_iterator_t* it); gmio_string_stream_fwd_iterator_t* it);
/*! Advances iterator so that next word is extracted into \p buffer
*
* \retval 0 On success
* \retval <=-1 On error
*/
int gmio_eat_word( int gmio_eat_word(
gmio_string_stream_fwd_iterator_t* it, gmio_string_buffer_t* buffer); gmio_string_stream_fwd_iterator_t* it, gmio_string_buffer_t* buffer);