From 13cf2a27522aa64242b38f22d7e19d47bd0dfd15 Mon Sep 17 00:00:00 2001
From: Jyri Sarha <jyri.sarha@linux.intel.com>
Date: Thu, 11 May 2023 17:52:27 +0300
Subject: [PATCH] topology2: doc: mixer.conf: Doxygenify and improve the
 existing comments

Improve and convert comments to doxygen documentation.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
---
 .../topology2/include/controls/mixer.conf     | 72 ++++++++++---------
 1 file changed, 38 insertions(+), 34 deletions(-)

diff --git a/tools/topology/topology2/include/controls/mixer.conf b/tools/topology/topology2/include/controls/mixer.conf
index 66b5085cf..191230ec5 100644
--- a/tools/topology/topology2/include/controls/mixer.conf
+++ b/tools/topology/topology2/include/controls/mixer.conf
@@ -1,41 +1,45 @@
-#
-# Mixer kcontrol class. All attributes defined herein are namespaced
-# by alsatplg to "Object.Control.mixer.N.attribute_name"
-#
-# Usage: this component can be used by instantiating it in the parent object. i.e.
-#
-# 	Object.Control.mixer."N" {
-#		index	1
-#		name	"1 Master Playback Volume"
-#		mas 32
-#			Object.Base.channel.1 {
-#				name "fl"
-#				shift	0
-#				reg 0
-#			}
-#			Object.Base.channel.2 {
-#				name "fr"
-#				shift 1
-#				reg 1
-#			}
-#			Object.Base.ops."ctl" {
-#				info "volsw"
-#				get "258"
-#				put "258"
-#			}
-#	}
-#
-# Where N is the unique instance number for the buffer object within the same alsaconf node.
-# The mixer control object should also include the ops, channels and tlv objects in the object
-# instance
+## \struct mixer
+## \brief Topology Mixer class
+##
+## All attributes defined herein are namespaced
+## by alsatplg to "Object.Control.mixer.N.attribute_name"
+##
+## Usage: this component can be used by instantiating it in the parent object. i.e.
+##
+## 	Object.Control.mixer."N" {
+##		index	1
+##		name	"1 Master Playback Volume"
+##		max 32
+##			Object.Base.channel.1 {
+##				name "fl"
+##				shift	0
+##				reg 0
+##			}
+##			Object.Base.channel.2 {
+##				name "fr"
+##				shift 1
+##				reg 1
+##			}
+##			Object.Base.ops."ctl" {
+##				info "volsw"
+##				get "258"
+##				put "258"
+##			}
+##		}
+##
+## The linked object instaces are \link channel \endlink and \link ops \endlink .
+##
+## Where N is the unique instance number for the buffer object within the same alsaconf node.
+## The mixer control object should also include the ops, channels and tlv objects in the object
+## instance
 
 <include/controls/common.conf>
 
 Class.Control."mixer" {
-	#
-	# Pipeline ID for the mixer object
-	#
-	DefineAttribute."index" {}
+	##
+	## @ Pipeline ID for the mixer object
+	##
+	DefineAttribute."index" {} ##< Automatically given unique index
 
 	#
 	# Instance of mixer object in the same alsaconf node