From b8eeef48f1ea02434360700e5cc5a43fb48e49e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damian=20Kara=C5=9B?= <s176030@student.pg.edu.pl>
Date: Sat, 13 Nov 2021 15:42:11 +0100
Subject: [PATCH] ALSA_support: comments improvement
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Damian Karaś <s176030@student.pg.edu.pl>
---
 src/include/ALSA_support.h | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/include/ALSA_support.h b/src/include/ALSA_support.h
index 54ff335..db07f8f 100644
--- a/src/include/ALSA_support.h
+++ b/src/include/ALSA_support.h
@@ -20,11 +20,14 @@ namespace DSP {
     
     class ALSA_object_t : public DSP::SOUND_object_t {
     private:
-        //! handlers
+        //! PCM device handler
         snd_pcm_t *alsa_handle;
+        //! copy of set configuration space handler 
         snd_pcm_hw_params_t *hw_params;
-    
+
+        //! stores pointers to audio buffers
         std::vector<uint8_t *> pcm_buffer;
+        //! stores size of audio buffers
         std::vector<snd_pcm_sframes_t> pcm_buffer_size_in_frames;
 
         //! output device number used in next open operations
@@ -32,13 +35,16 @@ namespace DSP {
         //! input device number used in next open operations 
         unsigned int InDevNo;
 
-        //! keeping track of which buffer is currently being filled
+        //! keeping track of which outbuffer is currently being filled
         unsigned int NextBufferOutInd;
+        //! keeping track of which inbuffer is currently being filled
         unsigned int NextBufferInInd;
 
-        //! variables holding values ​​from the external interface
+        //! sampling rate
         unsigned int sampling_rate_alsa;
+        //! number of channels
         unsigned int no_of_channels_alsa;
+        //! number of bytes in channel
         unsigned int no_of_bytes_in_channel;
 
         /*! It is better to use STD containers - they are more convenient, 
-- 
GitLab