From 0e1d5a48a9de75a1727510d4c8df23a93726e915 Mon Sep 17 00:00:00 2001
From: Daniel Leung <daniel.leung@intel.com>
Date: Thu, 6 Jan 2022 16:38:03 -0800
Subject: [PATCH] drivers: timer: remove @return doc for void functions

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>
---
 drivers/timer/arcv2_timer0.c       | 19 ++-----------------
 drivers/timer/native_posix_timer.c |  5 +----
 2 files changed, 3 insertions(+), 21 deletions(-)

diff --git a/drivers/timer/arcv2_timer0.c b/drivers/timer/arcv2_timer0.c
index 8ff594c9219..cad96f286fc 100644
--- a/drivers/timer/arcv2_timer0.c
+++ b/drivers/timer/arcv2_timer0.c
@@ -97,7 +97,6 @@ static volatile uint32_t overflow_cycles;
 #endif
 
 /**
- *
  * @brief Get contents of Timer0 count register
  *
  * @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
- *
- * @return N/A
  */
 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
  *
- * @return N/A
+ * @return Contents of Timer0 control register.
  */
 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
- *
- * @return N/A
  */
 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
  *
- * @return N/A
+ * @return Contents of Timer0 limit register.
  */
 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
- *
- * @return N/A
  */
 static ALWAYS_INLINE void timer0_limit_register_set(uint32_t count)
 {
@@ -210,14 +198,11 @@ static uint32_t elapsed(void)
 #endif
 
 /**
- *
  * @brief System clock periodic tick handler
  *
  * This routine handles the system clock tick interrupt. It always
  * announces one tick when TICKLESS is not enabled, or multiple ticks
  * when TICKLESS is enabled.
- *
- * @return N/A
  */
 static void timer_int_handler(const void *unused)
 {
diff --git a/drivers/timer/native_posix_timer.c b/drivers/timer/native_posix_timer.c
index 246e000646e..290d1ea5235 100644
--- a/drivers/timer/native_posix_timer.c
+++ b/drivers/timer/native_posix_timer.c
@@ -108,12 +108,9 @@ uint32_t sys_clock_elapsed(void)
 }
 
 /**
- *
  * @brief Stop announcing sys ticks into the kernel
  *
  * Disable the system ticks generation
- *
- * @return N/A
  */
 void sys_clock_disable(void)
 {
@@ -121,7 +118,7 @@ void sys_clock_disable(void)
 	hwtimer_set_silent_ticks(INT64_MAX);
 }
 
-/*
+/**
  * @brief Initialize system timer driver
  *
  * Enable the hw timer, setting its tick period, and setup its interrupt