From 82f6386256a4a5021fe244d3ce1686682d4ee191 Mon Sep 17 00:00:00 2001 From: Hugues Delorme Date: Mon, 30 Mar 2015 17:50:27 +0200 Subject: [PATCH] gmio_core: add more doc for gmio_stream::rewind_func() --- src/gmio_core/stream.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/gmio_core/stream.h b/src/gmio_core/stream.h index 79c0845..215226f 100644 --- a/src/gmio_core/stream.h +++ b/src/gmio_core/stream.h @@ -92,7 +92,11 @@ struct gmio_stream size_t (*size_func)(void* cookie); /*! Pointer on a function that moves the position indicator within the - * stream to the beginning */ + * stream to the beginning + * + * The function should behaves like C standard [rewind()] + * (http://pubs.opengroup.org/onlinepubs/007904975/functions/rewind.html) + */ void (*rewind_func)(void* cookie); };