From 22ec5b381136ba70d2a487a94050c529b4003b10 Mon Sep 17 00:00:00 2001
From: Jyri Sarha <jyri.sarha@linux.intel.com>
Date: Tue, 26 Sep 2023 22:55:30 +0300
Subject: [PATCH] topology2: doc: audio_format.conf: Translate comments to
 Doxygen

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
---
 .../include/common/audio_format.conf          | 73 ++++++++++---------
 1 file changed, 38 insertions(+), 35 deletions(-)

diff --git a/tools/topology/topology2/include/common/audio_format.conf b/tools/topology/topology2/include/common/audio_format.conf
index 8ee2e6bed..d572f3c00 100644
--- a/tools/topology/topology2/include/common/audio_format.conf
+++ b/tools/topology/topology2/include/common/audio_format.conf
@@ -1,43 +1,44 @@
-# Class definition for audio format object
-# audio_format objects can be instantiated as:
-#
-# Object.Base.audio_format."0" {
-#	in_rate			48000
-#	in_sample_container_size	16
-#	in_valid_bit_depth		16
-#	in_interleaving_style		"interleaved"
-#	out_rate			48000
-#	out_sample_container_size	16
-#	out_valid_bit_depth		16
-#	out_interleaving_style		"interleaved"
-
-# }
-#
+## \struct audio_format
+## \brief Class definition for audio format object
+##
+## audio_format objects can be instantiated as:
+##
+## 	Object.Base.audio_format."0" {
+##			in_rate			48000
+##			in_sample_container_size	16
+##			in_valid_bit_depth		16
+##			in_interleaving_style		"interleaved"
+##			out_rate			48000
+##			out_sample_container_size	16
+##			out_valid_bit_depth		16
+##			out_interleaving_style		"interleaved"
+##		}
+##
 
 Class.Base."audio_format" {
 
 	DefineAttribute."instance" {
 	}
 
-	# 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"
@@ -47,19 +48,19 @@ Class.Base."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
@@ -76,19 +77,20 @@ Class.Base."audio_format" {
 		}
 	}
 
-	# input format config
+	## input format config
 	DefineAttribute."in_fmt_cfg" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# output sampling rate
+	## output sampling rate
 	DefineAttribute."out_rate" {
 		# 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
@@ -104,19 +106,19 @@ Class.Base."audio_format" {
 		}
 	}
 
-	# output bit depth
+	## output bit depth
 	DefineAttribute."out_bit_depth" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# output valid bit depth
+	## output valid bit depth
 	DefineAttribute."out_valid_bit_depth" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# output channel count
+	## output channel count
 	DefineAttribute."out_channels" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
@@ -126,19 +128,19 @@ Class.Base."audio_format" {
 		}
 	}
 
-	# output channel map
+	## output channel map
 	DefineAttribute."out_ch_map" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# output channel config
+	## output channel config
 	DefineAttribute."out_ch_cfg" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
-	# output interleaving style
+	## output interleaving style
 	DefineAttribute."out_interleaving_style" {
 		type	"string"
 		# Token set reference name
@@ -155,14 +157,14 @@ Class.Base."audio_format" {
 		}
 	}
 
-	# output format config
+	## output format config
 	DefineAttribute."out_fmt_cfg" {
 		# Token set reference name
 		token_ref	"cavs_audio_format.word"
 	}
 
 	#
-	# input buffer size
+	## input buffer size
 	#
 	DefineAttribute."ibs" {
 		# Token set reference name and type
@@ -170,14 +172,15 @@ Class.Base."audio_format" {
 	}
 
 	#
-	# output buffer size
+	## output buffer size
 	#
 	DefineAttribute."obs" {
 		# Token set reference name and type
 		token_ref	"cavs_audio_format.word"
 	}
 
-	#output sample_type
+	## Output sample_type.
+	## Valid values for sample type are defined in common_definitions.conf.
 	DefineAttribute."out_sample_type" {
 		type string
 		# Token set reference name