From 7f794db27b53ef903d64a4fe38db5136cc4014b1 Mon Sep 17 00:00:00 2001
From: Daniel Leung <daniel.leung@intel.com>
Date: Thu, 6 Jan 2022 17:01:15 -0800
Subject: [PATCH] posix: 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>
---
 arch/posix/core/cpuhalt.c               | 3 ---
 boards/posix/native_posix/irq_handler.c | 8 +-------
 boards/posix/nrf52_bsim/irq_handler.c   | 8 +-------
 3 files changed, 2 insertions(+), 17 deletions(-)

diff --git a/arch/posix/core/cpuhalt.c b/arch/posix/core/cpuhalt.c
index f0b5bd08f41..cbac5f83ed7 100644
--- a/arch/posix/core/cpuhalt.c
+++ b/arch/posix/core/cpuhalt.c
@@ -48,12 +48,9 @@ void arch_cpu_atomic_idle(unsigned int key)
 
 #if defined(CONFIG_REBOOT)
 /**
- *
  * @brief Stub for sys_arch_reboot
  *
  * Does nothing
- *
- * @return N/A
  */
 void __weak sys_arch_reboot(int type)
 {
diff --git a/boards/posix/native_posix/irq_handler.c b/boards/posix/native_posix/irq_handler.c
index adde7346b5f..3ca7256c3e4 100644
--- a/boards/posix/native_posix/irq_handler.c
+++ b/boards/posix/native_posix/irq_handler.c
@@ -172,7 +172,6 @@ unsigned int posix_irq_lock(void)
 }
 
 /**
- *
  * @brief Enable all interrupts on the CPU
  *
  * This routine re-enables interrupts on the CPU.  The @a key parameter is a
@@ -180,9 +179,6 @@ unsigned int posix_irq_lock(void)
  * board_irq_lock().
  *
  * This routine can be called from either interrupt, task or fiber level.
- *
- * @return N/A
- *
  */
 void posix_irq_unlock(unsigned int key)
 {
@@ -238,14 +234,12 @@ void posix_isr_declare(unsigned int irq_p, int flags, void isr_p(const void *),
 	irq_vector_table[irq_p].flags = flags;
 }
 
-/*
+/**
  * @internal
  *
  * @brief Set an interrupt's priority
  *
  * Lower values take priority over higher values.
- *
- * @return N/A
  */
 void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags)
 {
diff --git a/boards/posix/nrf52_bsim/irq_handler.c b/boards/posix/nrf52_bsim/irq_handler.c
index d8b83cdc8e2..3a068c367ca 100644
--- a/boards/posix/nrf52_bsim/irq_handler.c
+++ b/boards/posix/nrf52_bsim/irq_handler.c
@@ -231,7 +231,6 @@ unsigned int posix_irq_lock(void)
 }
 
 /**
- *
  * @brief Enable all interrupts on the CPU
  *
  * This routine re-enables interrupts on the CPU.  The @a key parameter is a
@@ -239,9 +238,6 @@ unsigned int posix_irq_lock(void)
  * board_irq_lock().
  *
  * This routine can be called from either interrupt, task or fiber level.
- *
- * @return N/A
- *
  */
 void posix_irq_unlock(unsigned int key)
 {
@@ -297,14 +293,12 @@ void posix_isr_declare(unsigned int irq_p, int flags, void isr_p(const void *),
 	irq_vector_table[irq_p].flags = flags;
 }
 
-/*
+/**
  * @internal
  *
  * @brief Set an interrupt's priority
  *
  * Lower values take priority over higher values.
- *
- * @return N/A
  */
 void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags)
 {