Changeset 025d8cd for src/io/ioutils.h


Ignore:
Timestamp:
Dec 16, 2016, 1:01:17 PM (4 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler, yinfft+
Children:
562e908
Parents:
4c65cb8
Message:

src/io/ioutils.h: add basic documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/io/ioutils.h

    r4c65cb8 r025d8cd  
    2222#define AUBIO_IOUTILS_H
    2323
     24/** \file
     25
     26  Simple utility functions to validate input parameters.
     27
     28*/
     29
    2430#ifdef __cplusplus
    2531extern "C" {
    2632#endif
    2733
     34/** validate samplerate
     35
     36  \param kind       the object kind to report on
     37  \param path       the object properties to report on
     38  \param samplerate the object properties to report on
     39  \return  0 if ok, non-zero if validation failed
     40
     41 */
    2842uint_t aubio_io_validate_samplerate(const char_t *kind, const char_t *path,
    2943    uint_t samplerate);
    3044
     45/** validate number of channels
     46
     47  \param kind       the object kind to report on
     48  \param path       the object properties to report on
     49  \param channels   the object properties to report on
     50  \return  0 if ok, non-zero if validation failed
     51
     52 */
    3153uint_t aubio_io_validate_channels(const char_t *kind, const char_t *path,
    3254    uint_t channels);
Note: See TracChangeset for help on using the changeset viewer.