Skip to content

Commit f27cac1

Browse files
FymytePierrick Guillaume
authored andcommitted
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 <[email protected]>
1 parent f537cf3 commit f27cac1

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

include/zephyr/platform/hooks.h

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,20 @@ void soc_reset_hook(void);
3131
/**
3232
* @brief SoC hook executed after the reset vector.
3333
*
34-
*
3534
* This hook is implemented by the SoC and can be used to perform any
3635
* SoC-specific initialization.
3736
*/
3837
void soc_prep_hook(void);
3938

40-
/*
39+
/**
4140
* @brief SoC hook executed before the kernel and devices are initialized.
4241
*
4342
* This hook is implemented by the SoC and can be used to perform any
4443
* SoC-specific initialization.
4544
*/
4645
void soc_early_init_hook(void);
4746

48-
/*
47+
/**
4948
* @brief SoC hook executed after the kernel and devices are initialized.
5049
*
5150
* This hook is implemented by the SoC and can be used to perform any
@@ -61,7 +60,7 @@ void soc_late_init_hook(void);
6160
*/
6261
void soc_per_core_init_hook(void);
6362

64-
/*
63+
/**
6564
* @brief Board hook executed before the kernel starts.
6665
*
6766
* This is called before the kernel has started. This hook
@@ -70,9 +69,9 @@ void soc_per_core_init_hook(void);
7069
*/
7170
void board_early_init_hook(void);
7271

73-
/*
72+
/**
7473
* @brief Board hook executed after the kernel starts.
75-
74+
*
7675
* This is called after the kernel has started, but before the main function is
7776
* called. This hook is implemented by the board and can be used to perform
7877
* any board-specific initialization.

0 commit comments

Comments
 (0)