mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2026-03-06 01:40:09 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

ucm: docs: Fix doxygen formatting for UCM main page.

Browse source 
Make sure group is defined and lists dipplayed correctly.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Liam Girdwood 2015-06-29 16:25:58 +01:00 • committed by Takashi Iwai
parent f66c7cc293
commit bb92545e06
1 changed files with 9 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

20
include/use-case.h
View file

@ -43,15 +43,13 @@ extern "C" {
#endif #endif
/** /**
* \defgroup Use Case Interface * \defgroup ucm Use Case Interface
* The ALSA Use Case manager interface. * The ALSA Use Case manager interface.
* See \ref Usecase page for more details. * See \ref Usecase page for more details.
* \{ * \{
*/ */
/*! \page Usecase ALSA Use Case Interface /*! \page Usecase ALSA Use Case Interface
*
* ALSA Use Case Interface
* *
* The use case manager works by configuring the sound card ALSA kcontrols to * The use case manager works by configuring the sound card ALSA kcontrols to
* change the hardware digital and analog audio routing to match the requested * change the hardware digital and analog audio routing to match the requested
@ -69,9 +67,9 @@ extern "C" {
* *
* However there are times when a use case has to be modified at runtime. e.g. * However there are times when a use case has to be modified at runtime. e.g.
* *
* o Incoming phone call when the device is playing music * + Incoming phone call when the device is playing music
* o Recording sections of a phone call * + Recording sections of a phone call
* o Playing tones during a call. * + Playing tones during a call.
* *
* In order to allow asynchronous runtime use case adaptations, we have a third * In order to allow asynchronous runtime use case adaptations, we have a third
* optional modifier parameter that can be used to further configure * optional modifier parameter that can be used to further configure
@ -79,13 +77,13 @@ extern "C" {
* *
* This interface allows clients to :- * This interface allows clients to :-
* *
* o Query the supported use case verbs, devices and modifiers for the machine. * + Query the supported use case verbs, devices and modifiers for the machine.
* o Set and Get use case verbs, devices and modifiers for the machine. * + Set and Get use case verbs, devices and modifiers for the machine.
* o Get the ALSA PCM playback and capture device PCMs for use case verb, * + Get the ALSA PCM playback and capture device PCMs for use case verb,
* use case device and modifier. * use case device and modifier.
* o Get the TQ parameter for each use case verb, use case device and * + Get the TQ parameter for each use case verb, use case device and
* modifier. * modifier.
* o Get the ALSA master playback and capture volume/switch kcontrols * + Get the ALSA master playback and capture volume/switch kcontrols
* for each use case. * for each use case.
*/ */