Skip to content

Commit 5e2c907

Browse files
committed
[doxygen][audio] Fix group names by adding group_ prefix
Signed-off-by: 1078249029 <[email protected]>
1 parent db359af commit 5e2c907

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

components/drivers/audio/dev_audio.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ static rt_ssize_t _audio_dev_write(struct rt_device *dev, rt_off_t pos, const vo
548548
*
549549
* @param[in] dev pointer to device
550550
*
551-
* @param[in] cmd audio cmd, it can be one of value in @ref audio_control
551+
* @param[in] cmd audio cmd, it can be one of value in @ref group_audio_control
552552
*
553553
* @param[in] args command argument
554554
*
@@ -693,7 +693,7 @@ rt_err_t rt_audio_register(struct rt_audio_device *audio, const char *name, rt_u
693693
/**
694694
* @brief Set audio sample rate
695695
*
696-
* @param[in] bitValue audio sample rate, it can be one of value in @ref audio_samp_rates
696+
* @param[in] bitValue audio sample rate, it can be one of value in @ref group_audio_samp_rates
697697
*
698698
* @return speed has been set
699699
*/

components/drivers/include/drivers/dev_audio.h

+16-16
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*/
2727

2828
/**
29-
* @defgroup audio_control AUDIO_CTL
29+
* @defgroup group_audio_control AUDIO_CTL
3030
*
3131
* @brief Control audio device.
3232
*
@@ -48,10 +48,10 @@
4848
#define AUDIO_CTL_STOP _AUDIO_CTL(4) /**< Stop audio device */
4949
#define AUDIO_CTL_GETBUFFERINFO _AUDIO_CTL(5) /**< Get audio device buffer information */
5050

51-
/** @} */ /* End of audio_control */
51+
/** @} */ /* End of group_audio_control*/
5252

5353
/**
54-
* @defgroup audio_type AUDIO_TYPE
54+
* @defgroup group_audio_type AUDIO_TYPE
5555
*
5656
* @brief Audio Device Types
5757
*
@@ -61,10 +61,10 @@
6161
#define AUDIO_TYPE_INPUT 0x01 /**< Set audio device type to input type */
6262
#define AUDIO_TYPE_OUTPUT 0x02 /**< Set audio device type to output type */
6363
#define AUDIO_TYPE_MIXER 0x04 /**< Set audio device type to mixer type */
64-
/** @} */ /* End of audio_type */
64+
/** @} */ /* End of group_audio_type*/
6565

6666
/**
67-
* @defgroup audio_samp_rates AUDIO_SAMP_RATES
67+
* @defgroup group_audio_samp_rates AUDIO_SAMP_RATES
6868
*
6969
* @brief Supported audio sample rates for the audio device.
7070
*
@@ -82,10 +82,10 @@
8282
#define AUDIO_SAMP_RATE_160K 0x0200 /**< Set audio device sample rate to 160K */
8383
#define AUDIO_SAMP_RATE_172K 0x0400 /**< Set audio device sample rate to 172K */
8484
#define AUDIO_SAMP_RATE_192K 0x0800 /**< Set audio device sample rate to 192K */
85-
/** @} */ /* End of audio_samp_rates */
85+
/** @} */ /* End of group_audio_samp_rates*/
8686

8787
/**
88-
* @defgroup audio_bit_rates AUDIO_BIT_RATES
88+
* @defgroup group_audio_bit_rates AUDIO_BIT_RATES
8989
*
9090
* @brief Supported bit rates for the audio device.
9191
*
@@ -99,11 +99,11 @@
9999
#define AUDIO_BIT_RATE_160K 0x20 /**< Set audio device bit rates to 160K */
100100
#define AUDIO_BIT_RATE_172K 0x40 /**< Set audio device bit rates to 172K */
101101
#define AUDIO_BIT_RATE_192K 0x80 /**< Set audio device bit rates to 192K */
102-
/** @} */ /* End of audio_bit_rates */
102+
/** @} */ /* End of group_audio_bit_rates */
103103

104104

105105
/**
106-
* @defgroup audio_dsp AUDIO_DSP
106+
* @defgroup group_audio_dsp AUDIO_DSP
107107
*
108108
* @brief Support Dsp(input/output) Units controls. The macro group from application level, can
109109
* set audio mixer parameters including samplerate, channels etc.
@@ -114,10 +114,10 @@
114114
#define AUDIO_DSP_SAMPLERATE 1 /**< samplerate */
115115
#define AUDIO_DSP_CHANNELS 2 /**< channels */
116116
#define AUDIO_DSP_SAMPLEBITS 3 /**< sample bits width */
117-
/** @} */ /* End of audio_dsp */
117+
/** @} */ /* End of group_audio_dsp */
118118

119119
/**
120-
* @defgroup audio_mixer AUDIO_MIXER
120+
* @defgroup group_audio_mixer AUDIO_MIXER
121121
*
122122
* @brief Supported Mixer Units controls. The macro group from driver level, can set audio mixer
123123
* parameters including volume, frequence db, microphone etc.
@@ -136,7 +136,7 @@
136136
#define AUDIO_MIXER_MIC 0x0100 /**< Set microphone option */
137137
#define AUDIO_MIXER_VITURAL 0x0200 /**< Set virtual audio option */
138138
#define AUDIO_MIXER_EXTEND 0x8000 /**< Extend mixer command */
139-
/** @} */ /* End of audio_mixer */
139+
/** @} */ /* End of group_audio_mixer*/
140140

141141
#define AUDIO_VOLUME_MAX (100)
142142
#define AUDIO_VOLUME_MIN (0)
@@ -213,8 +213,8 @@ struct rt_audio_configure
213213
*/
214214
struct rt_audio_caps
215215
{
216-
int main_type; /**< Audio main type, one value of @ref audio_type */
217-
int sub_type; /**< Audio sub type, one value of @ref audio_dsp @ref audio_mixer */
216+
int main_type; /**< Audio main type, one value of @ref group_audio_type */
217+
int sub_type; /**< Audio sub type, one value of @ref group_audio_dsp or @ref group_audio_mixer */
218218

219219
union
220220
{
@@ -269,7 +269,7 @@ void rt_audio_tx_complete(struct rt_audio_device *audio);
269269
void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t len);
270270

271271
/**
272-
* @defgroup audio_codec_cmd CODEC_CMD
272+
* @defgroup group_audio_codec_cmd CODEC_CMD
273273
*
274274
* @brief Device Control Commands. The macro group from hardware level, can set codec
275275
* parametes including volume, EQ and 3D etc.
@@ -284,7 +284,7 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt
284284
#define CODEC_CMD_3D 5 /**< Set 3D effect by codec */
285285

286286
#define CODEC_VOLUME_MAX (63)
287-
/** @} */ /* End of audio_codec_cmd */
287+
/** @} */ /* End of group_audio_codec_cmd*/
288288

289289
/** @} group_Audio */
290290

0 commit comments

Comments
 (0)