michaelh/zephyr
1
0
Fork 0
Code Releases Activity

audio: remove @return doc for void functions

Browse source 
For functions returning nothing, there is no need to document
with @return, as Doxgen complains about "documented empty
return type of ...".

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 17:29:08 -08:00 • committed by Anas Nashif
commit d2e28da06b
2 changed files with 0 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/audio/codec.h
View file

@ -156,8 +156,6 @@ static inline int audio_codec_configure(const struct device *dev,
* Setup the audio codec device to start the audio playback
*
* @param dev Pointer to the device structure for codec driver instance.
*
* @return none
*/
static inline void audio_codec_start_output(const struct device *dev)
{
@ -173,8 +171,6 @@ static inline void audio_codec_start_output(const struct device *dev)
* Setup the audio codec device to stop the audio playback
*
* @param dev Pointer to the device structure for codec driver instance.
*
* @return none
*/
static inline void audio_codec_stop_output(const struct device *dev)
{

2
include/audio/dmic.h
View file

@ -203,8 +203,6 @@ static inline uint32_t dmic_build_channel_map(uint8_t channel, uint8_t pdm,
* @param channel The logical channel number
* @param pdm Pointer to the PDM hardware controller number
* @param lr Pointer to the LEFT/RIGHT channel within the PDM controller
*
* @return none
*/
static inline void dmic_parse_channel_map(uint32_t channel_map_lo,
uint32_t channel_map_hi, uint8_t channel, uint8_t *pdm, enum pdm_lr *lr)