From 649ac7d2d2b655c5eb37f5694b8eb6c70472881f Mon Sep 17 00:00:00 2001
From: Jyri Sarha <jyri.sarha@linux.intel.com>
Date: Wed, 27 Sep 2023 18:56:55 +0300
Subject: [PATCH] topology2: doc: input_audio_format.conf: Translate comments
 to Doxygen

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
---
 .../include/common/input_audio_format.conf    | 45 ++++++++++---------
 1 file changed, 24 insertions(+), 21 deletions(-)

diff --git a/tools/topology/topology2/include/common/input_audio_format.conf b/tools/topology/topology2/include/common/input_audio_format.conf
index f5b9956d841b..795f3cdb46b0 100644
--- a/tools/topology/topology2/include/common/input_audio_format.conf
+++ b/tools/topology/topology2/include/common/input_audio_format.conf
@@ -1,14 +1,16 @@
-# Class definition for input pin audio format object
-# audio_format objects can be instantiated as:
-#
-# Object.Base.input_audio_format."0" {
-#	in_rate			48000
-#	in_sample_container_size	16
-#	in_valid_bit_depth		16
-#	in_interleaving_style		"interleaved"
-
-# }
-#
+## \struct input_audio_format
+## \brief Volume playback pipeline
+##
+## Class definition for input pin audio format object
+## audio_format objects can be instantiated as:
+##
+## 	Object.Base.input_audio_format."0" {
+##			in_rate			48000
+##			in_sample_container_size	16
+##			in_valid_bit_depth		16
+##			in_interleaving_style		"interleaved"
+##		}
+##
 
 Class.Base."input_audio_format" {
 
@@ -20,25 +22,25 @@ Class.Base."input_audio_format" {
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input sampling rate
+	## input sampling rate
 	DefineAttribute."in_rate" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input bit depth
+	## input bit depth
 	DefineAttribute."in_bit_depth" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input valid bit depth
+	## input valid bit depth
 	DefineAttribute."in_valid_bit_depth" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input channel count
+	## input channel count
 	DefineAttribute."in_channels" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
@@ -48,19 +50,19 @@ Class.Base."input_audio_format" {
 		}
 	}
 
-	# input channel map
+	## input channel map
 	DefineAttribute."in_ch_map" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input channel config
+	## input channel config
 	DefineAttribute."in_ch_cfg" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input interleaving style
+	## input interleaving style
 	DefineAttribute."in_interleaving_style" {
 		type	"string"
 		# Token set reference name
@@ -77,13 +79,14 @@ Class.Base."input_audio_format" {
 		}
 	}
 
-	# input format config
+	## input format config
 	DefineAttribute."in_fmt_cfg" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# input sample_type
+	## Input sample_type.
+	## Valid values for sample type are defined in common_definitions.conf.
 	DefineAttribute."in_sample_type" {
 		type string
 		# Token set reference name
@@ -100,7 +103,7 @@ Class.Base."input_audio_format" {
 	}
 
 	#
-	# input buffer size
+	## input buffer size
 	#
 	DefineAttribute."ibs" {
 		# Token set reference name and type