src/io/sndfileio.h: add documentation

diff --git a/src/io/sndfileio.h b/src/io/sndfileio.h
index a697188779891230a22d09c527c888ddfecaaf2e..73d78b0a943e905c778340486574bf2c1ea5521b 100644 (file)
--- a/src/io/sndfileio.h
+++ b/src/io/sndfileio.h
@@ -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

diff --git a/src/tempo/beattracking.h b/src/tempo/beattracking.h
index d4406d05576cf9c6056e362d0f14167310827e9f..78534b5413d6cc66c80897942280c662b0da3990 100644 (file)
--- a/src/tempo/beattracking.h
+++ b/src/tempo/beattracking.h
@@ -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