michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix @param usage in callbacks

Browse source 
The proper usage of @param in callbacks is currently unsupported by
Doxygen so not warnings are generated. The issues fixed with this commit
where found while adding support to Doxygen for validating @param in
callbacks like it currently does for functions.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
This commit is contained in:
Fabio Utzig 2020-12-16 20:22:38 -03:00 • committed by Carles Cufí
commit 8713da70a3
15 changed files with 38 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

1
include/usb/class/usb_audio.h
View file

@ -195,6 +195,7 @@ typedef void (*usb_audio_data_completion_cb_t)(const struct device *dev,
*
* @warning Host may not use all of configured features.
*
* @param dev USB Audio device
* @param evt Pointer to an event to be parsed by the App.
* Pointer sturct is temporary and is valid only during the
* execution of this callback.