src/io/source.h: add [out] decorator to doxystring

[aubio.git] / src / io / source.h

diff --git a/src/io/source.h b/src/io/source.h
index 9a4ac23..e47a2a8 100644 (file)
--- a/src/io/source.h
+++ b/src/io/source.h
@@ -76,7 +76,7 @@ void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
 
   \param s source object, created with ::new_aubio_source
   \param read_to ::fmat_t of data to read to
 
   \param s source object, created with ::new_aubio_source
   \param read_to ::fmat_t of data to read to

-  \param read upon returns, equals to number of frames actually read
+  \param[out] read upon returns, equals to number of frames actually read

 
   Upon returns, `read` contains the number of frames actually read from the
   source. `hop_size` if enough frames could be read, less otherwise.
 
   Upon returns, `read` contains the number of frames actually read from the
   source. `hop_size` if enough frames could be read, less otherwise.