From 3f5dea85bc54e567b3485bf7ef37027e44e444b9 Mon Sep 17 00:00:00 2001
From: trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>
Date: Wed, 17 Mar 2021 21:17:34 +0000
Subject: added ChannelMap documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@9757 90c681e8-e032-0410-971d-27865f9a5e38
---
 src/qmmp/audioconverter.h |  2 +-
 src/qmmp/channelmap.cpp   |  1 -
 src/qmmp/channelmap.h     | 20 +++++++++++++++++---
 3 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/src/qmmp/audioconverter.h b/src/qmmp/audioconverter.h
index 1402c5390..265a3bf69 100644
--- a/src/qmmp/audioconverter.h
+++ b/src/qmmp/audioconverter.h
@@ -24,7 +24,7 @@
 #include <stddef.h>
 #include "qmmp.h"
 
-/*! @brief The AbstractEngine class provides the internal audio converter
+/*! @brief The AbstractEngine class provides the internal audio converter.
  * @author Ilya Kotov <forkotov02@ya.ru>
  */
 class QMMP_EXPORT AudioConverter
diff --git a/src/qmmp/channelmap.cpp b/src/qmmp/channelmap.cpp
index 1eb09aa3c..59f10a1bf 100644
--- a/src/qmmp/channelmap.cpp
+++ b/src/qmmp/channelmap.cpp
@@ -31,7 +31,6 @@ Qmmp::ChannelPosition ChannelMap::m_internal_map[9] = { Qmmp::CHAN_FRONT_LEFT,
                                                         Qmmp::CHAN_LFE,
                                                         Qmmp::CHAN_SIDE_LEFT,
                                                         Qmmp::CHAN_SIDE_RIGHT };
-ChannelMap::ChannelMap() {}
 
 ChannelMap::ChannelMap(int channels)
 {
diff --git a/src/qmmp/channelmap.h b/src/qmmp/channelmap.h
index d047e5f99..df1f511a4 100644
--- a/src/qmmp/channelmap.h
+++ b/src/qmmp/channelmap.h
@@ -24,14 +24,28 @@
 #include <QList>
 #include "qmmp.h"
 
+/*! @brief This class represents audio channel mapping.
+ * @author Ilya Kotov <forkotov02@ya.ru>
+ */
 class QMMP_EXPORT ChannelMap : public QList<Qmmp::ChannelPosition>
 {
 public:
-    ChannelMap();
-    explicit ChannelMap(int channels);
-
+    /*!
+     * Constructs channel mapping with internal order.
+     * \param channels Number channels
+     */
+    explicit ChannelMap(int channels = 0);
+    /*!
+     * Returns a mask with used channels.
+     */
     int mask() const;
+    /*!
+     * Converts current channel order to internal.
+     */
     const ChannelMap remaped() const;
+    /*!
+     * Converts channel channel mapping to string representation (for debug purposes).
+     */
     const QString toString() const;
 
 private:
-- 
cgit v1.2.3-13-gbd6f