michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: timer: remove @return doc for void functions

Browse source 
For functions returning nothing, there is no need to document
with @return, as Doxgen complains about "documented empty
return type of ...".

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 16:38:03 -08:00 • committed by Anas Nashif
commit 0e1d5a48a9
2 changed files with 3 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

19
drivers/timer/arcv2_timer0.c
View file

@ -97,7 +97,6 @@ static volatile uint32_t overflow_cycles;
#endif #endif
/** /**
*
* @brief Get contents of Timer0 count register * @brief Get contents of Timer0 count register
* *
* @return Current Timer0 count * @return Current Timer0 count
@ -108,10 +107,7 @@ static ALWAYS_INLINE uint32_t timer0_count_register_get(void)
} }
/** /**
*
* @brief Set Timer0 count register to the specified value * @brief Set Timer0 count register to the specified value
*
* @return N/A
*/ */
static ALWAYS_INLINE void timer0_count_register_set(uint32_t value) static ALWAYS_INLINE void timer0_count_register_set(uint32_t value)
{ {
@ -119,10 +115,9 @@ static ALWAYS_INLINE void timer0_count_register_set(uint32_t value)
} }
/** /**
*
* @brief Get contents of Timer0 control register * @brief Get contents of Timer0 control register
* *
* @return N/A * @return Contents of Timer0 control register.
*/ */
static ALWAYS_INLINE uint32_t timer0_control_register_get(void) static ALWAYS_INLINE uint32_t timer0_control_register_get(void)
{ {
@ -130,10 +125,7 @@ static ALWAYS_INLINE uint32_t timer0_control_register_get(void)
} }
/** /**
*
* @brief Set Timer0 control register to the specified value * @brief Set Timer0 control register to the specified value
*
* @return N/A
*/ */
static ALWAYS_INLINE void timer0_control_register_set(uint32_t value) static ALWAYS_INLINE void timer0_control_register_set(uint32_t value)
{ {
@ -141,10 +133,9 @@ static ALWAYS_INLINE void timer0_control_register_set(uint32_t value)
} }
/** /**
*
* @brief Get contents of Timer0 limit register * @brief Get contents of Timer0 limit register
* *
* @return N/A * @return Contents of Timer0 limit register.
*/ */
static ALWAYS_INLINE uint32_t timer0_limit_register_get(void) static ALWAYS_INLINE uint32_t timer0_limit_register_get(void)
{ {
@ -152,10 +143,7 @@ static ALWAYS_INLINE uint32_t timer0_limit_register_get(void)
} }
/** /**
*
* @brief Set Timer0 limit register to the specified value * @brief Set Timer0 limit register to the specified value
*
* @return N/A
*/ */
static ALWAYS_INLINE void timer0_limit_register_set(uint32_t count) static ALWAYS_INLINE void timer0_limit_register_set(uint32_t count)
{ {
@ -210,14 +198,11 @@ static uint32_t elapsed(void)
#endif #endif
/** /**
*
* @brief System clock periodic tick handler * @brief System clock periodic tick handler
* *
* This routine handles the system clock tick interrupt. It always * This routine handles the system clock tick interrupt. It always
* announces one tick when TICKLESS is not enabled, or multiple ticks * announces one tick when TICKLESS is not enabled, or multiple ticks
* when TICKLESS is enabled. * when TICKLESS is enabled.
*
* @return N/A
*/ */
static void timer_int_handler(const void *unused) static void timer_int_handler(const void *unused)
{ {

5
drivers/timer/native_posix_timer.c
View file

@ -108,12 +108,9 @@ uint32_t sys_clock_elapsed(void)
} }
/** /**
*
* @brief Stop announcing sys ticks into the kernel * @brief Stop announcing sys ticks into the kernel
* *
* Disable the system ticks generation * Disable the system ticks generation
*
* @return N/A
*/ */
void sys_clock_disable(void) void sys_clock_disable(void)
{ {
@ -121,7 +118,7 @@ void sys_clock_disable(void)
hwtimer_set_silent_ticks(INT64_MAX); hwtimer_set_silent_ticks(INT64_MAX);
} }
/* /**
* @brief Initialize system timer driver * @brief Initialize system timer driver
* *
* Enable the hw timer, setting its tick period, and setup its interrupt * Enable the hw timer, setting its tick period, and setup its interrupt