ref: 025d8cddec53cb5a1c52cfccbc865a47e4b810db
parent: 4c65cb88e6e8f1dc287a3955476257a45e65d60d
author: Paul Brossier <[email protected]>
date: Fri Dec 16 08:01:17 EST 2016
src/io/ioutils.h: add basic documentation
--- a/src/io/ioutils.h
+++ b/src/io/ioutils.h
@@ -21,13 +21,35 @@
#ifndef AUBIO_IOUTILS_H
#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);