From: Paul Brossier <piem@piem.org>
Date: Fri, 16 Dec 2016 12:01:17 +0000 (+0100)
Subject: src/io/ioutils.h: add basic documentation
X-Git-Tag: 0.4.4~51
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=025d8cddec53cb5a1c52cfccbc865a47e4b810db;p=aubio.git

src/io/ioutils.h: add basic documentation
---

diff --git a/src/io/ioutils.h b/src/io/ioutils.h
index 7d716afc..7eb65cbc 100644
--- 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);