mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

ucm: docs: typeset lists of identifiers explicitly

Browse source 
Doxygen doesn't preserve formatting that relies only on indentation,
typeset lists of identifiers explicitly.

This makes the HTML docs a lot more readable.

This change comes along the lines of commit 72aa0f8332 ("ucm: reformat
snd_use_case_get() doc").

Some TABs has been added too in order to preserve the aligned look when
reading the source code.

Signed-off-by: Antonio Ospite <ao2@ao2.it>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Antonio Ospite 2016-09-23 18:18:57 +02:00 • committed by Takashi Iwai
parent 4ec907c773
commit 64481b3c72
1 changed files with 29 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

57
include/use-case.h
View file

@ -192,20 +192,21 @@ int snd_use_case_free_list(const char *list[], int items);
* \return Number of list entries if success, otherwise a negative error code
*
* Defined identifiers:
* NULL - get card list
* (in pair cardname+comment)
* _verbs - get verb list
* (in pair verb+comment)
* _devices[/{verb}] - get list of supported devices
* (in pair device+comment)
* _modifiers[/{verb}]- get list of supported modifiers
* (in pair modifier+comment)
* TQ[/{verb}] - get list of TQ identifiers
* _enadevs - get list of enabled devices
* _enamods - get list of enabled modifiers
* - NULL - get card list
* (in pair cardname+comment)
* - _verbs - get verb list
* (in pair verb+comment)
* - _devices[/{verb}] - get list of supported devices
* (in pair device+comment)
* - _modifiers[/{verb}] - get list of supported modifiers
* (in pair modifier+comment)
* - TQ[/{verb}] - get list of TQ identifiers
* - _enadevs - get list of enabled devices
* - _enamods - get list of enabled modifiers
*
* - _supporteddevs/{modifier}|{device}[/{verb}] - list of supported devices
* - _conflictingdevs/{modifier}|{device}[/{verb}] - list of conflicting devices
*
* _supporteddevs/{modifier}|{device}[/{verb}] - list of supported devices
* _conflictingdevs/{modifier}|{device}[/{verb}] - list of conflicting devices
* Note that at most one of the supported/conflicting devs lists has
* any entries, and when neither is present, all devices are supported.
*
@ -331,8 +332,8 @@ int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
* \return Zero if success, otherwise a negative error code
*
* Known identifiers:
* _devstatus/{device} - return status for given device
* _modstatus/{modifier} - return status for given modifier
* - _devstatus/{device} - return status for given device
* - _modstatus/{modifier} - return status for given modifier
*/
int snd_use_case_geti(snd_use_case_mgr_t *uc_mgr,
const char *identifier,
@ -346,19 +347,19 @@ int snd_use_case_geti(snd_use_case_mgr_t *uc_mgr,
* \return Zero if success, otherwise a negative error code
*
* Known identifiers:
* _verb - set current verb = value
* _enadev - enable given device = value
* _disdev - disable given device = value
* _swdev/{old_device} - new_device = value
* - disable old_device and then enable new_device
* - if old_device is not enabled just return
* - check transmit sequence firstly
* _enamod - enable given modifier = value
* _dismod - disable given modifier = value
* _swmod/{old_modifier} - new_modifier = value
* - disable old_modifier and then enable new_modifier
* - if old_modifier is not enabled just return
* - check transmit sequence firstly
* - _verb - set current verb = value
* - _enadev - enable given device = value
* - _disdev - disable given device = value
* - _swdev/{old_device} - new_device = value
* - disable old_device and then enable new_device
* - if old_device is not enabled just return
* - check transmit sequence firstly
* - _enamod - enable given modifier = value
* - _dismod - disable given modifier = value
* - _swmod/{old_modifier} - new_modifier = value
* - disable old_modifier and then enable new_modifier
* - if old_modifier is not enabled just return
* - check transmit sequence firstly
*/
int snd_use_case_set(snd_use_case_mgr_t *uc_mgr,
const char *identifier,