From 273185b45aa6f9ec445b47faba688b6b7dbd3f66 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Fri, 10 Oct 2025 10:05:06 +0800 Subject: 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 * 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 --- components/drivers/include/drivers/dev_can.h | 2 -- 1 file changed, 2 deletions(-) (limited to 'components/drivers/include') 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); -- cgit v1.3.1