]> git.alsa-project.org Git - alsa-lib.git/commitdiff
doxygen: fix list indentation errors
authorborine <32966433+borine@users.noreply.github.com>
Sat, 29 Jul 2023 13:30:30 +0000 (14:30 +0100)
committerJaroslav Kysela <perex@perex.cz>
Fri, 1 Sep 2023 14:11:15 +0000 (16:11 +0200)
From: borine@github
Link: https://github.com/alsa-project/alsa-lib/pull/340
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
include/use-case.h

index 95f792d8f821624a41262ed60f69007785aa8e64..297664ee9759fdc3d96dfa1e7c832f4fa5ce2f40 100644 (file)
@@ -325,10 +325,10 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
  *      - playback control device name
  *   - PlaybackVolume
  *      - playback control volume identifier string
- *     - can be parsed using snd_use_case_parse_ctl_elem_id()
+ *      - can be parsed using #snd_use_case_parse_ctl_elem_id()
  *   - PlaybackSwitch
  *      - playback control switch identifier string
- *     - can be parsed using snd_use_case_parse_ctl_elem_id()
+ *         - can be parsed using #snd_use_case_parse_ctl_elem_id()
  *   - PlaybackPriority
  *      - priority value (1-10000), higher value means higher priority
  *   - CaptureRate
@@ -345,20 +345,20 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
  *      - capture control device name
  *   - CaptureVolume
  *      - capture control volume identifier string
- *     - can be parsed using snd_use_case_parse_ctl_elem_id()
+ *         - can be parsed using #snd_use_case_parse_ctl_elem_id()
  *   - CaptureSwitch
  *      - capture control switch identifier string
- *     - can be parsed using snd_use_case_parse_ctl_elem_id()
+ *         - can be parsed using #snd_use_case_parse_ctl_elem_id()
  *   - CapturePriority
  *      - priority value (1-10000), higher value means higher priority
  *   - PlaybackMixer
  *      - name of playback mixer
  *   - PlaybackMixerElem
  *      - mixer element playback identifier
- *     - can be parsed using snd_use_case_parse_selem_id()
+ *         - can be parsed using #snd_use_case_parse_selem_id()
  *   - PlaybackMasterElem
  *      - mixer element playback identifier for the master control
- *     - can be parsed using snd_use_case_parse_selem_id()
+ *         - can be parsed using #snd_use_case_parse_selem_id()
  *   - PlaybackMasterType
  *      - type of the master volume control
  *      - Valid values: "soft" (software attenuation)
@@ -366,10 +366,10 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
  *      - name of capture mixer
  *   - CaptureMixerElem
  *      - mixer element capture identifier
- *     - can be parsed using snd_use_case_parse_selem_id()
+ *         - can be parsed using #snd_use_case_parse_selem_id()
  *   - CaptureMasterElem
  *      - mixer element playback identifier for the master control
- *     - can be parsed using snd_use_case_parse_selem_id()
+ *         - can be parsed using #snd_use_case_parse_selem_id()
  *   - CaptureMasterType
  *      - type of the master volume control
  *      - Valid values: "soft" (software attenuation)
@@ -405,9 +405,9 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
  *        but that's application policy configuration that doesn't belong
  *        to UCM configuration files.
  *   - MinBufferLevel
- *     - This is used on platform where reported buffer level is not accurate.
- *       E.g. "512", which holds 512 samples in device buffer. Note: this will
- *       increase latency.
+ *      - This is used on platform where reported buffer level is not accurate.
+ *        E.g. "512", which holds 512 samples in device buffer. Note: this will
+ *        increase latency.
  */
 int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
                      const char *identifier,
@@ -436,24 +436,24 @@ int snd_use_case_geti(snd_use_case_mgr_t *uc_mgr,
  * \return Zero if success, otherwise a negative error code
  *
  * Known identifiers:
- *   - _fboot                  - execute the fixed boot sequence (value = NULL)
- *   - _boot                   - execute the boot sequence (value = NULL)
- *                                - only when driver controls identifiers are changed
- *                                  (otherwise the old control values are restored)
- *   - _defaults               - execute the 'defaults' sequence (value = NULL)
- *   - _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
+ *   - _fboot           - execute the fixed boot sequence (value = NULL)
+ *   - _boot            - execute the boot sequence (value = NULL)
+ *                      - only when driver controls identifiers are changed
+ *                        (otherwise the old control values are restored)
+ *   - _defaults        - execute the 'defaults' sequence (value = NULL)
+ *   - _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
+ *                      - 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,