From: borine <32966433+borine@users.noreply.github.com>
Date: Sat, 29 Jul 2023 10:08:25 +0000 (+0100)
Subject: doxygen: fix broken parameter name tags
X-Git-Tag: v1.2.10~24
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=9505cfdb4603269684725c9c7514dd5a937f6d6b;p=alsa-lib.git

doxygen: fix broken parameter name tags

From: borine@github
Link: https://github.com/alsa-project/alsa-lib/pull/340
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/include/mixer.h b/include/mixer.h
index 51b6f04a..735dfdd8 100644
--- a/include/mixer.h
+++ b/include/mixer.h
@@ -47,7 +47,7 @@ typedef struct _snd_mixer_elem snd_mixer_elem_t;
 
 /** 
  * \brief Mixer callback function
- * \param mixer Mixer handle
+ * \param ctl Mixer handle
  * \param mask event mask
  * \param elem related mixer element (if any)
  * \return 0 on success otherwise a negative error code
diff --git a/include/use-case.h b/include/use-case.h
index e5d4fd68..95f792d8 100644
--- a/include/use-case.h
+++ b/include/use-case.h
@@ -534,7 +534,7 @@ static __inline__ int snd_use_case_verb_list(snd_use_case_mgr_t *uc_mgr,
 
 /**
  * \brief Parse control element identifier
- * \param elem_id Element identifier
+ * \param dst Element identifier
  * \param ucm_id Use case identifier
  * \param value String value to be parsed
  * \return Zero if success, otherwise a negative error code
diff --git a/src/conf.c b/src/conf.c
index da51182e..9887d0e9 100644
--- a/src/conf.c
+++ b/src/conf.c
@@ -2055,7 +2055,7 @@ int snd_config_load(snd_config_t *config, snd_input_t *in)
 
 /**
  * \brief Loads a configuration tree from a string.
- * \param[out] The function puts the handle to the configuration
+ * \param[out] config The function puts the handle to the configuration
  *	       node loaded from the file(s) at the address specified
  *             by \a config.
  * \param[in] s String with the ASCII configuration
@@ -2260,9 +2260,9 @@ static int _snd_config_array_merge(snd_config_t *dst, snd_config_t *src, int ind
 
 /**
  * \brief In-place merge of two config handles
- * \param dst[out] Config handle for the merged contents
- * \param src[in] Config handle to merge into dst (may be NULL)
- * \param override[in] Override flag
+ * \param[out] dst Config handle for the merged contents
+ * \param[in] src Config handle to merge into dst (may be NULL)
+ * \param[in] override Override flag
  * \return Zero if successful, otherwise a negative error code.
  *
  * This function merges all fields from the source compound to the destination compound.
diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index 75ceab6e..16cfe493 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -2234,7 +2234,7 @@ const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode)
 
 /**
  * \brief get name of PCM tstamp type setting
- * \param mode PCM tstamp type
+ * \param type PCM tstamp type
  * \return ascii name of PCM tstamp type setting
  */
 const char *snd_pcm_tstamp_type_name(snd_pcm_tstamp_type_t type)
@@ -3439,10 +3439,10 @@ int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_areas, snd_pcm_uframes_
 
 /**
  * \brief Copy one or more areas
- * \param dst_areas destination areas specification (one for each channel)
+ * \param dst_channels destination areas specification (one for each channel)
  * \param dst_offset offset in frames inside destination area
  * \param dst_size size in frames of the destination buffer
- * \param src_areas source areas specification (one for each channel)
+ * \param src_channels source areas specification (one for each channel)
  * \param src_offset offset in frames inside source area
  * \param dst_size size in frames of the source buffer
  * \param channels channels count
@@ -7022,7 +7022,7 @@ void snd_pcm_status_get_driver_htstamp(const snd_pcm_status_t *obj, snd_htimesta
 /**
  * \brief Get audio_tstamp_report from a PCM status container
  * \param obj pointer to #snd_pcm_status_t
- * \param ptr Pointer to returned report (valid fields are accuracy and type)
+ * \param audio_tstamp_report Pointer to returned report (valid fields are accuracy and type)
  */
 void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj,
 					     snd_pcm_audio_tstamp_report_t *audio_tstamp_report)
@@ -7036,7 +7036,7 @@ void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj,
 /**
  * \brief set audio_tstamp_config from a PCM status container
  * \param obj pointer to #snd_pcm_status_t
- * \param ptr Pointer to config (valid fields are type and report_analog_delay)
+ * \param audio_tstamp_config Pointer to config (valid fields are type and report_analog_delay)
  */
 void snd_pcm_status_set_audio_htstamp_config(snd_pcm_status_t *obj,
 					     snd_pcm_audio_tstamp_config_t *audio_tstamp_config)
diff --git a/src/rawmidi/ump.c b/src/rawmidi/ump.c
index 80fa5140..119b58f6 100644
--- a/src/rawmidi/ump.c
+++ b/src/rawmidi/ump.c
@@ -315,7 +315,7 @@ size_t snd_ump_endpoint_info_sizeof(void)
 
 /**
  * \brief allocate the snd_ump_endpoint_info_t structure
- * \param ptr returned pointer
+ * \param info returned pointer
  * \return 0 on success otherwise a negative error code if fails
  *
  * Allocates a new snd_rawmidi_status_t structure using the standard
@@ -331,7 +331,7 @@ int snd_ump_endpoint_info_malloc(snd_ump_endpoint_info_t **info)
 
 /**
  * \brief frees the snd_ump_endpoint_info_t structure
- * \param status pointer to the snd_ump_endpoint_info_t structure to free
+ * \param info pointer to the snd_ump_endpoint_info_t structure to free
  *
  * Frees the given snd_ump_endpoint_info_t structure using the standard
  * free C library function.
@@ -504,7 +504,7 @@ size_t snd_ump_block_info_sizeof(void)
 
 /**
  * \brief allocate the snd_ump_block_info_t structure
- * \param ptr returned pointer
+ * \param info returned pointer
  * \return 0 on success otherwise a negative error code if fails
  *
  * Allocates a new snd_ump_block_info_t structure using the standard
@@ -520,7 +520,7 @@ int snd_ump_block_info_malloc(snd_ump_block_info_t **info)
 
 /**
  * \brief frees the snd_ump_block_info_t structure
- * \param status pointer to the snd_ump_block_info_t structure to free
+ * \param info pointer to the snd_ump_block_info_t structure to free
  *
  * Frees the given snd_ump_block_info_t structure using the standard
  * free C library function.
diff --git a/src/ucm/main.c b/src/ucm/main.c
index 66ffd00d..7675398b 100644
--- a/src/ucm/main.c
+++ b/src/ucm/main.c
@@ -2791,7 +2791,7 @@ int snd_use_case_set(snd_use_case_mgr_t *uc_mgr,
 
 /**
  * \brief Parse control element identifier
- * \param elem_id Element identifier
+ * \param dst Element identifier
  * \param ucm_id Use case identifier
  * \param value String value to be parsed
  * \return Zero if success, otherwise a negative error code