diff options
| author | Chen Wang <[email protected]> | 2025-10-10 10:05:06 +0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-10-10 10:05:06 +0800 |
| commit | 273185b45aa6f9ec445b47faba688b6b7dbd3f66 (patch) | |
| tree | 7c0edcbcdd27e15edfb3b83482c5b148cef3c2aa /components/drivers | |
| parent | 1aef0dba719d9080690ca370605fdee947296dec (diff) | |
doxygen: fix two issues when building with doxygen 1.9.8 (#10768)
* doxygen: remove @return command if function return void
When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen
reports: "doxygen error: found documented return type for xxx
that does not return anything" for those functions which return
void but declare "@return" in doxygen comment.
Solution: remove "@return" for those cases, and update
guide document for how to write doxgen comment for functions.
Signed-off-by: Chen Wang <[email protected]>
* doxygen: fixed a minor typo for uart doc
This error is found when building with doxygen 1.9.8, but not
detecetd on 1.9.1.
Signed-off-by: Chen Wang <[email protected]>
Diffstat (limited to 'components/drivers')
| -rw-r--r-- | components/drivers/audio/dev_audio.c | 4 | ||||
| -rw-r--r-- | components/drivers/include/drivers/dev_can.h | 2 |
2 files changed, 0 insertions, 6 deletions
diff --git a/components/drivers/audio/dev_audio.c b/components/drivers/audio/dev_audio.c index c4e806ca28..338ee67a0f 100644 --- a/components/drivers/audio/dev_audio.c +++ b/components/drivers/audio/dev_audio.c @@ -751,8 +751,6 @@ int rt_audio_samplerate_to_speed(rt_uint32_t bitValue) * See _audio_send_replay_frame for details * * @param[in] audio pointer to audio device - * - * @return void */ void rt_audio_tx_complete(struct rt_audio_device *audio) { @@ -768,8 +766,6 @@ void rt_audio_tx_complete(struct rt_audio_device *audio) * @param[in] pbuf pointer ro data to be received * * @param[in] len buffer size - * - * @return void */ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t len) { diff --git a/components/drivers/include/drivers/dev_can.h b/components/drivers/include/drivers/dev_can.h index aa4878ee51..ef91302742 100644 --- a/components/drivers/include/drivers/dev_can.h +++ b/components/drivers/include/drivers/dev_can.h @@ -709,8 +709,6 @@ rt_err_t rt_hw_can_register(struct rt_can_device *can, * * @param[in] can A pointer to the CAN device structure. * @param[in] event The interrupt event mask, indicating the cause of the interrupt. - * - * @return void */ void rt_hw_can_isr(struct rt_can_device *can, int event); |