src/io/sndfileio.h: add documentation
authorPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 03:45:59 +0000 (22:45 -0500)
committerPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 03:45:59 +0000 (22:45 -0500)
src/io/sndfileio.h
src/tempo/beattracking.h

index a697188..73d78b0 100644 (file)
@@ -69,6 +69,9 @@ void aubio_sndfile_info(aubio_sndfile_t * file);
  * Return number of channel in file
  */
 uint_t aubio_sndfile_channels(aubio_sndfile_t * file);
+/**
+ * Return samplerate of a file (Hz)
+ */
 uint_t aubio_sndfile_samplerate(aubio_sndfile_t * file);
 
 #ifdef __cplusplus
index d4406d0..78534b5 100644 (file)
@@ -32,6 +32,8 @@
   Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
   towards automatic musical accompaniment. In Proceedings of the Audio
   Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
+
+  \example tempo/test-beattracking.h
   
 */
 #ifndef BEATTRACKING_H