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

ucm: reformat snd_use_case_get() doc

Browse source 
Doxygen doesn't preserve formatting that relies only on indentation.
This fixes it by using lists more liberally.

There are probably more places to fix than just
snd_use_case_get_list(), but I only have motivation for fixing this
function's documentation formatting (the next patch will add some more
content to the function's documentation).

Signed-off-by: Tanu Kaskinen <tanu.kaskinen@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Tanu Kaskinen 2015-03-05 14:51:57 +02:00 • committed by Takashi Iwai
parent 9d649add08
commit 72aa0f8332
1 changed files with 65 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

97
include/use-case.h
View file

@ -229,10 +229,10 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* "const", but it's too late to fix it, sorry about that.) * "const", but it's too late to fix it, sorry about that.)
* *
* Known identifiers: * Known identifiers:
* NULL - return current card * - NULL - return current card
* _verb - return current verb * - _verb - return current verb
* *
* [=]{NAME}[/[{modifier}|{/device}][/{verb}]] * - [=]{NAME}[/[{modifier}|{/device}][/{verb}]]
* - value identifier {NAME} * - value identifier {NAME}
* - Search starts at given modifier or device if any, * - Search starts at given modifier or device if any,
* else at a verb * else at a verb
@ -243,51 +243,70 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* device/modifier/verb specified, and not search * device/modifier/verb specified, and not search
* through each object in turn. * through each object in turn.
* - Examples: * - Examples:
* "PlaybackPCM/Play Music" * - "PlaybackPCM/Play Music"
* "CapturePCM/SPDIF" * - "CapturePCM/SPDIF"
* From ValueDefaults only: * - From ValueDefaults only:
* "=Variable" * "=Variable"
* From current active verb: * - From current active verb:
* "=Variable//" * "=Variable//"
* From verb "Verb": * - From verb "Verb":
* "=Variable//Verb" * "=Variable//Verb"
* From "Modifier" in current active verb: * - From "Modifier" in current active verb:
* "=Variable/Modifier/" * "=Variable/Modifier/"
* From "Modifier" in "Verb": * - From "Modifier" in "Verb":
* "=Variable/Modifier/Verb" * "=Variable/Modifier/Verb"
* *
* Recommended names for values: * Recommended names for values:
* TQ - Tone Quality * - TQ
* PlaybackPCM - full PCM playback device name * - Tone Quality
* PlaybackPCMIsDummy - Valid values: "yes" and "no". If set to "yes", the * - PlaybackPCM
* PCM named by the PlaybackPCM value is a dummy device, * - full PCM playback device name
* meaning that opening it enables an audio path in the * - PlaybackPCMIsDummy
* hardware, but writing to the PCM device has no * - Valid values: "yes" and "no". If set to "yes", the PCM named by the
* PlaybackPCM value is a dummy device, meaning that opening it enables
* an audio path in the hardware, but writing to the PCM device has no
* effect. * effect.
* CapturePCM - full PCM capture device name * - CapturePCM
* CapturePCMIsDummy - Valid values: "yes" and "no". If set to "yes", the * - full PCM capture device name
* PCM named by the CapturePCM value is a dummy device, * - CapturePCMIsDummy
* meaning that opening it enables an audio path in the * - Valid values: "yes" and "no". If set to "yes", the PCM named by the
* hardware, but reading from the PCM device has no * CapturePCM value is a dummy device, meaning that opening it enables
* an audio path in the hardware, but reading from the PCM device has no
* effect. * effect.
* PlaybackRate - playback device sample rate * - PlaybackRate
* PlaybackChannels - playback device channel count * - playback device sample rate
* PlaybackCTL - playback control device name * - PlaybackChannels
* PlaybackVolume - playback control volume ID string * - playback device channel count
* PlaybackSwitch - playback control switch ID string * - PlaybackCTL
* CaptureRate - capture device sample rate * - playback control device name
* CaptureChannels - capture device channel count * - PlaybackVolume
* CaptureCTL - capture control device name * - playback control volume ID string
* CaptureVolume - capture control volume ID string * - PlaybackSwitch
* CaptureSwitch - capture control switch ID string * - playback control switch ID string
* PlaybackMixer - name of playback mixer * - CaptureRate
* PlaybackMixerID - mixer playback ID * - capture device sample rate
* CaptureMixer - name of capture mixer * - CaptureChannels
* CaptureMixerID - mixer capture ID * - capture device channel count
* JackDev - jack device name * - CaptureCTL
* JackControl - jack control name * - capture control device name
* JackHWMute - indicate if the HW mutes a device on jack insertion * - CaptureVolume
* or not. * - capture control volume ID string
* - CaptureSwitch
* - capture control switch ID string
* - PlaybackMixer
* - name of playback mixer
* - PlaybackMixerID
* - mixer playback ID
* - CaptureMixer
* - name of capture mixer
* - CaptureMixerID
* - mixer capture ID
* - JackDev
* - jack device name
* - JackControl
* - jack control name
* - JackHWMute
* - indicate if the HW mutes a device on jack insertion or not.
*/ */
int snd_use_case_get(snd_use_case_mgr_t *uc_mgr, int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
const char *identifier, const char *identifier,