Changeset 025d8cd for src/io/ioutils.h

Timestamp:

Dec 16, 2016, 1:01:17 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler, yinfft+

Children:

562e908

Parents:

4c65cb8

Message:

src/io/ioutils.h: add basic documentation

File:

• src/io/ioutils.h (modified) (1 diff)

src/io/ioutils.h

@@ -22 +22 @@
 #define AUBIO_IOUTILS_H
 
+/** \file
+
+  Simple utility functions to validate input parameters.
+
+*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/** validate samplerate
+
+  \param kind       the object kind to report on
+  \param path       the object properties to report on
+  \param samplerate the object properties to report on
+  \return  0 if ok, non-zero if validation failed
+
+ */
 uint_t aubio_io_validate_samplerate(const char_t *kind, const char_t *path,
     uint_t samplerate);
 
+/** validate number of channels
+
+  \param kind       the object kind to report on
+  \param path       the object properties to report on
+  \param channels   the object properties to report on
+  \return  0 if ok, non-zero if validation failed
+
+ */
 uint_t aubio_io_validate_channels(const char_t *kind, const char_t *path,
     uint_t channels);