OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Jyri Sarha 2023-09-01 13:06:10 +03:00 committed by Liam Girdwood
parent 13cf2a2752
commit 2e9589069a
1 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
tools/topology/topology2/include/pipelines/volume-playback.conf
View File

@ -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"
}