michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: interrupt_controller: remove @return doc for void funcs

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:35:43 -08:00 • committed by Anas Nashif
commit 975e257f2c
7 changed files with 13 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

22
drivers/interrupt_controller/intc_plic.c
View file

@ -35,16 +35,14 @@ struct plic_regs_t {
static int save_irq;
/**
*
* @brief Enable a riscv PLIC-specific interrupt line
*
* This routine enables a RISCV PLIC-specific interrupt line.
* riscv_plic_irq_enable is called by SOC_FAMILY_RISCV_PRIVILEGE
* arch_irq_enable function to enable external interrupts for
* IRQS level == 2, whenever CONFIG_RISCV_HAS_PLIC variable is set.
* @param irq IRQ number to enable
*
* @return N/A
* @param irq IRQ number to enable
*/
void riscv_plic_irq_enable(uint32_t irq)
{
@ -58,16 +56,14 @@ void riscv_plic_irq_enable(uint32_t irq)
}
/**
*
* @brief Disable a riscv PLIC-specific interrupt line
*
* This routine disables a RISCV PLIC-specific interrupt line.
* riscv_plic_irq_disable is called by SOC_FAMILY_RISCV_PRIVILEGE
* arch_irq_disable function to disable external interrupts, for
* IRQS level == 2, whenever CONFIG_RISCV_HAS_PLIC variable is set.
* @param irq IRQ number to disable
*
* @return N/A
* @param irq IRQ number to disable
*/
void riscv_plic_irq_disable(uint32_t irq)
{
@ -81,7 +77,6 @@ void riscv_plic_irq_disable(uint32_t irq)
}
/**
*
* @brief Check if a riscv PLIC-specific interrupt line is enabled
*
* This routine checks if a RISCV PLIC-specific interrupt line is enabled.
@ -98,15 +93,14 @@ int riscv_plic_irq_is_enabled(uint32_t irq)
}
/**
*
* @brief Set priority of a riscv PLIC-specific interrupt line
*
* This routine set the priority of a RISCV PLIC-specific interrupt line.
* riscv_plic_irq_set_prio is called by riscv arch_irq_priority_set to set
* the priority of an interrupt whenever CONFIG_RISCV_HAS_PLIC variable is set.
* @param irq IRQ number for which to set priority
*
* @return N/A
* @param irq IRQ number for which to set priority
* @param priority Priority of IRQ to set to
*/
void riscv_plic_set_priority(uint32_t irq, uint32_t priority)
{
@ -120,14 +114,12 @@ void riscv_plic_set_priority(uint32_t irq, uint32_t priority)
}
/**
*
* @brief Get riscv PLIC-specific interrupt line causing an interrupt
*
* This routine returns the RISCV PLIC-specific interrupt line causing an
* interrupt.
* @param irq IRQ number for which to set priority
*
* @return N/A
* @return PLIC-specific interrupt line causing an interrupt.
*/
int riscv_plic_get_irq(void)
{
@ -174,9 +166,9 @@ static void plic_irq_handler(const void *arg)
}
/**
*
* @brief Initialize the Platform Level Interrupt Controller
* @return N/A
*
* @retval 0 on success.
*/
static int plic_init(const struct device *dev)
{