From e28a0c1fada32344b73bf86d9d63f77da56e9449 Mon Sep 17 00:00:00 2001
From: Jyri Sarha <jyri.sarha@linux.intel.com>
Date: Fri, 1 Sep 2023 13:06:10 +0300
Subject: [PATCH] topology2: doc: volume-playback.conf: Doxygenify exsisting
 comments

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
---
 .../include/pipelines/volume-playback.conf    | 59 ++++++++++---------
 1 file changed, 31 insertions(+), 28 deletions(-)

diff --git a/tools/topology/topology2/include/pipelines/volume-playback.conf b/tools/topology/topology2/include/pipelines/volume-playback.conf
index d04830b2168a..cf8c7d34a304 100644
--- a/tools/topology/topology2/include/pipelines/volume-playback.conf
+++ b/tools/topology/topology2/include/pipelines/volume-playback.conf
@@ -1,24 +1,26 @@
-#
-# Volume playback pipeline
-#
-# A simple pipeline. All attributes defined herein are namespaced by alsatplg to
-# "Object.Pipeline.volume-playback.N.attribute_name"
-#
-# Usage: this component can be used by declaring in the top-level topology conf file as follows:
-#
-# 	Object.Pipeline.volume-playback."N" {
-#		format		"s16le"
-#		period		1000
-#		time_domain	"timer"
-#		channels	2
-#		rate		48000
-#	}
-#
-# where N is the unique pipeline_id for this pipeline object within the same alsaconf node.
-#
-#
-# (source) host.N.playback -> buffer.N.1 -> volume.N.1 -> buffer.N.2 (sink endpoint)
-#
+## \struct volume_playback
+## \brief Volume playback pipeline
+##
+## \par Instantiating volume-playback pipeline
+##
+## A simple pipeline. All attributes defined herein are namespaced by alsatplg
+## to "Object.Pipeline.volume-playback.N.attribute_name"
+##
+## Usage: this component can be used by declaring in the top-level topology conf file as follows:
+##
+## 	Object.Pipeline.volume-playback."N" {
+##			format		"s16le"
+##			period		1000
+##			time_domain	"timer"
+##			channels	2
+##			rate		48000
+##		}
+##
+## where N is the unique pipeline_id for this pipeline object within the same alsaconf node.
+##
+##
+## (source) host.N.playback -> buffer.N.1 -> volume.N.1 -> buffer.N.2 (sink endpoint)
+##
 
 <include/common/route.conf>
 <include/components/buffer.conf>
@@ -27,11 +29,11 @@
 <include/components/volume.conf>
 
 Class.Pipeline."volume-playback" {
-	# include common pipeline attribute definitions
+	## include common pipeline attribute definitions
 	<include/pipelines/pipeline-common.conf>
 
 	attributes {
-		# pipeline name is constructed as "volume-playback.1"
+		## pipeline name is constructed as "volume-playback.1"
 		!constructor [
 			"index"
 		]
@@ -42,8 +44,8 @@ Class.Pipeline."volume-playback" {
 			"direction"
 		]
 		#
-		# volume-playback objects instantiated within the same alsaconf node must have
-		# unique index attribute
+		## volume-playback objects instantiated within the same alsaconf node must have
+		## unique index attribute
 		#
 		unique	"instance"
 	}
@@ -52,6 +54,7 @@ Class.Pipeline."volume-playback" {
 		pipeline."1" {}
 
 		host."playback" {
+			## "aif_in" is for playback
 			type			"aif_in"
 		}
 
@@ -74,9 +77,9 @@ Class.Pipeline."volume-playback" {
 		}
 	}
 
-	# Pipeline connections
-	# The index attribute values for the source/sink widgets will be populated
-	# when the route objects are built
+	## Pipeline connections
+	## The index attribute values for the source/sink widgets will be populated
+	## when the route objects are built
 	Object.Base {
 		route."1" {
 			source	"host.$index.playback"