From: Paul Brossier <piem@piem.org>
Date: Tue, 17 Dec 2013 16:37:52 +0000 (-0500)
Subject: src/musicutils.h: minimal doc about windows
X-Git-Tag: 0.4.0~7
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=e84ab0495ecc201a2005bf0cac2739b0a62d68f6;p=aubio.git

src/musicutils.h: minimal doc about windows
---

diff --git a/src/musicutils.h b/src/musicutils.h
index 04e71dfa..885024ac 100644
--- a/src/musicutils.h
+++ b/src/musicutils.h
@@ -30,7 +30,24 @@ extern "C" {
 #endif
 
 /** create window 
+
+  \param window_type type of the window to create
+  \param size length of the window to create (see fvec_set_window())
  
+*/
+fvec_t *new_aubio_window (char_t * window_type, uint_t size);
+
+/** set elements of a vector to window coefficients
+
+  \param window exsting ::fvec_t to use
+  \param window_type type of the window to create
+
+  List of available window types: "rectangle", "hamming", "hanning",
+  "hanningz", "blackman", "blackman_harris", "gaussian", "welch", "parzen",
+  "default".
+
+  "default" is equivalent to "hanningz".
+
   References:
     
     - <a href="http://en.wikipedia.org/wiki/Window_function">Window
@@ -42,11 +59,6 @@ Uni- versity of Verona, Italy, 2000.
   (<a href="http://profs.sci.univr.it/%7Edafx/Final-Papers/ps/Bernardini.ps.gz">
   ps.gz</a>)
 
-*/
-fvec_t *new_aubio_window (char_t * window_type, uint_t size);
-
-/** set elements of a vector to window coefficients
-
  */
 uint_t fvec_set_window (fvec_t * window, char_t * window_type);