michaelh/zephyr
1
0
Fork 0
Code Releases Activity

posix: 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 17:01:15 -08:00 • committed by Anas Nashif
commit 7f794db27b
3 changed files with 2 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

3
arch/posix/core/cpuhalt.c
View file

@ -48,12 +48,9 @@ void arch_cpu_atomic_idle(unsigned int key)
#if defined(CONFIG_REBOOT) #if defined(CONFIG_REBOOT)
/** /**
*
* @brief Stub for sys_arch_reboot * @brief Stub for sys_arch_reboot
* *
* Does nothing * Does nothing
*
* @return N/A
*/ */
void __weak sys_arch_reboot(int type) void __weak sys_arch_reboot(int type)
{ {

8
boards/posix/native_posix/irq_handler.c
View file

@ -172,7 +172,6 @@ unsigned int posix_irq_lock(void)
} }
/** /**
*
* @brief Enable all interrupts on the CPU * @brief Enable all interrupts on the CPU
* *
* This routine re-enables interrupts on the CPU. The @a key parameter is a * 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(). * board_irq_lock().
* *
* This routine can be called from either interrupt, task or fiber level. * This routine can be called from either interrupt, task or fiber level.
*
* @return N/A
*
*/ */
void posix_irq_unlock(unsigned int key) 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; irq_vector_table[irq_p].flags = flags;
} }
/* /**
* @internal * @internal
* *
* @brief Set an interrupt's priority * @brief Set an interrupt's priority
* *
* Lower values take priority over higher values. * Lower values take priority over higher values.
*
* @return N/A
*/ */
void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags) void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags)
{ {

8
boards/posix/nrf52_bsim/irq_handler.c
View file

@ -231,7 +231,6 @@ unsigned int posix_irq_lock(void)
} }
/** /**
*
* @brief Enable all interrupts on the CPU * @brief Enable all interrupts on the CPU
* *
* This routine re-enables interrupts on the CPU. The @a key parameter is a * 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(). * board_irq_lock().
* *
* This routine can be called from either interrupt, task or fiber level. * This routine can be called from either interrupt, task or fiber level.
*
* @return N/A
*
*/ */
void posix_irq_unlock(unsigned int key) 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; irq_vector_table[irq_p].flags = flags;
} }
/* /**
* @internal * @internal
* *
* @brief Set an interrupt's priority * @brief Set an interrupt's priority
* *
* Lower values take priority over higher values. * Lower values take priority over higher values.
*
* @return N/A
*/ */
void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags) void posix_irq_priority_set(unsigned int irq, unsigned int prio, uint32_t flags)
{ {