From 3e04c639549873f752dc077d8a0e5cf58fa12c7b Mon Sep 17 00:00:00 2001 From: "Alfred E. Heggestad" Date: Sun, 29 Nov 2015 09:48:26 +0100 Subject: modules: update documentation header --- modules/vumeter/vumeter.c | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'modules/vumeter/vumeter.c') diff --git a/modules/vumeter/vumeter.c b/modules/vumeter/vumeter.c index 827bde2..efefa23 100644 --- a/modules/vumeter/vumeter.c +++ b/modules/vumeter/vumeter.c @@ -9,6 +9,17 @@ #include +/** + * @defgroup vumeter vumeter + * + * Simple ASCII VU-meter for the audio-signal. + * + * The Volume unit (VU) meter module takes the audio-signal as input + * and prints a simple ASCII-art bar for the recording and playback levels. + * It is using the aufilt API to get the audio samples. + */ + + struct vumeter_enc { struct aufilt_enc_st af; /* inheritance */ struct tmr tmr; -- cgit v1.2.3