From f27cac1152e1cfd3716aa410ee0892a137f47138 Mon Sep 17 00:00:00 2001 From: Pierrick Guillaume Date: Fri, 15 Nov 2024 09:55:45 +0100 Subject: [PATCH] init: fix soc and board hooks doxygen comments Documentation for *init_hooks were not generated on doc website. This was due to ill-formed doc-strings for those hooks. Signed-off-by: Pierrick Guillaume --- include/zephyr/platform/hooks.h | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/include/zephyr/platform/hooks.h b/include/zephyr/platform/hooks.h index d310b0c37ca47..9989f640d65e7 100644 --- a/include/zephyr/platform/hooks.h +++ b/include/zephyr/platform/hooks.h @@ -31,13 +31,12 @@ void soc_reset_hook(void); /** * @brief SoC hook executed after the reset vector. * - * * This hook is implemented by the SoC and can be used to perform any * SoC-specific initialization. */ void soc_prep_hook(void); -/* +/** * @brief SoC hook executed before the kernel and devices are initialized. * * This hook is implemented by the SoC and can be used to perform any @@ -45,7 +44,7 @@ void soc_prep_hook(void); */ void soc_early_init_hook(void); -/* +/** * @brief SoC hook executed after the kernel and devices are initialized. * * This hook is implemented by the SoC and can be used to perform any @@ -61,7 +60,7 @@ void soc_late_init_hook(void); */ void soc_per_core_init_hook(void); -/* +/** * @brief Board hook executed before the kernel starts. * * This is called before the kernel has started. This hook @@ -70,9 +69,9 @@ void soc_per_core_init_hook(void); */ void board_early_init_hook(void); -/* +/** * @brief Board hook executed after the kernel starts. - + * * This is called after the kernel has started, but before the main function is * called. This hook is implemented by the board and can be used to perform * any board-specific initialization.