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

topology2: doc: widget-common.conf: Attribute comments to Doxygen 

Change attribute comments to Doxygen comments.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
This commit is contained in:
Jyri Sarha 2023-09-19 12:32:18 +03:00 committed by Liam Girdwood
parent 2e9589069a
commit c7f0e930f2
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
tools/topology/topology2/include/components/widget-common.conf
View File

@ -2,12 +2,12 @@
# Common widget attribute definitions
#
# instance of the widget object
## instance of the widget object
DefineAttribute."instance" {}
#
# no_pm - maps to the DAPM widget's reg field
# "false" value indicates that there is no direct DAPM for this widget
## no_pm - maps to the DAPM widget's reg field
## "false" value indicates that there is no direct DAPM for this widget
#
DefineAttribute."no_pm" {
type "string"
@ -20,26 +20,26 @@ DefineAttribute."no_pm" {
}
#
# Widget Type - maps to the widget ID with values of type enum SND_SOC_TPLG_DAPM_*
## Widget Type - maps to the widget ID with values of type enum SND_SOC_TPLG_DAPM_*
#
DefineAttribute."type" {
type "string"
}
#
# Stream name - maps to the DAPM widget's stream name
## Stream name - maps to the DAPM widget's stream name
#
DefineAttribute."stream_name" {
type "string"
}
#
# Event type widget binds to
## Event type widget binds to
#
DefineAttribute.event_type {}
#
# Widget event flags
## Widget event flags
#
DefineAttribute.event_flags {}
@ -47,7 +47,7 @@ DefineAttribute.event_flags {}
# Attributes with a "token_ref" value will be added to widget's private data
#
# widget format
## widget format
DefineAttribute."format" {
type "string"
# Token set reference name and type
@ -62,49 +62,50 @@ DefineAttribute."format" {
}
}
# ID of the core this widget should be scheduled on
## ID of the core this widget should be scheduled on
DefineAttribute."core_id" {
# Token set reference name and type
token_ref "comp.word"
}
# number of periods to preload
## number of periods to preload
DefineAttribute."preload_count" {
# Token set reference name and type
token_ref "comp.word"
}
# Number of sink pins a widget can support
## Number of sink pins a widget can support
DefineAttribute."num_input_pins" {
# Token set reference name and type
token_ref "comp.word"
}
# Number of source pins a widget can support
## Number of source pins a widget can support
DefineAttribute."num_output_pins" {
# Token set reference name and type
token_ref "comp.word"
}
# Number of supported sink(input) audio formats
## Number of supported sink(input) audio formats
DefineAttribute."num_input_audio_formats" {
# Token set reference name and type
token_ref "comp.word"
}
# Number of supported source(output) audio formats
## Number of supported source(output) audio formats
DefineAttribute."num_output_audio_formats" {
# Token set reference name and type
token_ref "comp.word"
}
# Widget UUID
## Widget UUID
DefineAttribute.uuid {
type "string"
# Token set reference name and type
token_ref "comp.uuid"
}
## Whether to add this widget's name to the beginning of all its associated mixer names
DefineAttribute."no_wname_in_kcontrol_name" {
type "string"
# Token set reference name