From 2e9589069a6c75abbbdf3b188d8304b7d5ecf955 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 existing
 comments

Doxygenify all comments that are correctly placed near the attribute's
or objects C-translation. This is not the case for comments before
Object.Base { } definition or comment before including
pipeline-common.conf, which is inlined by the topology2 filter, does
not end up in any relevant place, so its better just leave those
comments as they are. They can anyway be read from topology2 source
snippets.

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

diff --git a/tools/topology/topology2/include/pipelines/volume-playback.conf b/tools/topology/topology2/include/pipelines/volume-playback.conf
index d04830b21..fa007609a 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>
@@ -31,7 +33,7 @@ Class.Pipeline."volume-playback" {
 	<include/pipelines/pipeline-common.conf>
 
 	attributes {
-		# pipeline name is constructed as "volume-playback.1"
+		## pipeline name is constructed as "volume-playback.1"
 		!constructor [
 			"index"
 		]
@@ -49,9 +51,11 @@ Class.Pipeline."volume-playback" {
 	}
 
 	Object.Widget {
+		## The pipeline object for captured playback
 		pipeline."1" {}
 
 		host."playback" {
+			## "aif_in" is for playback
 			type			"aif_in"
 		}