doxygen: add @brief and capitalize
Remove function name from comment and add @brief instead.
Also capitilize first letter.
Change-Id: Ib708b49bf02e5bc89b0066637a55874e659637e0
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
diff --git a/drivers/interrupt_controller/arcv2_irq_unit.c b/drivers/interrupt_controller/arcv2_irq_unit.c
index 2ca2cef..afb2b17 100644
--- a/drivers/interrupt_controller/arcv2_irq_unit.c
+++ b/drivers/interrupt_controller/arcv2_irq_unit.c
@@ -44,7 +44,7 @@
#include <board.h>
/*
- * _arc_v2_irq_unit_init - initialize the interrupt unit device driver
+ * @brief Initialize the interrupt unit device driver
*
* Initializes the interrupt unit device driver and the device
* itself.
@@ -69,7 +69,7 @@
}
/*
- * _arc_v2_irq_unit_int_eoi - send EOI signal to interrupt unit
+ * @brief Send EOI signal to interrupt unit
*
* This routine sends an EOI (End Of Interrupt) signal to the interrupt unit
* to clear a pulse-triggered interrupt.
@@ -87,7 +87,7 @@
}
/*
- * _arc_v2_irq_unit_int_trigger_set - sets an IRQ line to level/pulse trigger
+ * @brief Sets an IRQ line to level/pulse trigger
*
* Sets the IRQ line <irq> to trigger an interrupt based on the level or the
* edge of the signal. Valid values for <trigger> are _ARC_V2_INT_LEVEL and
diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c
index 2e58f8d..6fa4144 100644
--- a/drivers/interrupt_controller/i8259.c
+++ b/drivers/interrupt_controller/i8259.c
@@ -118,7 +118,7 @@
/**
*
- * _i8259_init - initialize the Intel 8259A PIC device driver
+ * @brief Initialize the Intel 8259A PIC device driver
*
* This routine initializes the Intel 8259A PIC device driver and the device
* itself.
@@ -187,7 +187,7 @@
#ifndef CONFIG_SHUTOFF_PIC
/**
*
- * _i8259_eoi_master - send EOI(end of interrupt) signal to the master PIC.
+ * @brief Send EOI(end of interrupt) signal to the master PIC.
*
* This routine is called at the end of the interrupt handler.
*
@@ -209,7 +209,7 @@
/**
*
- * _i8259_eoi_slave - send EOI(end of interrupt) signal to the slave PIC.
+ * @brief Send EOI(end of interrupt) signal to the slave PIC.
*
* This routine is called at the end of the interrupt handler in the Normal
* Fully Nested Mode.
@@ -241,7 +241,7 @@
/**
*
- * __I8259IntEnable - enable/disable a specified PIC interrupt input line
+ * @brief Enable/disable a specified PIC interrupt input line
*
* This routine enables or disables a specified PIC interrupt input line. To
* enable an interrupt input line, the parameter <enable> must be non-zero.
@@ -292,7 +292,7 @@
/**
*
- * _i8259_irq_disable - disable a specified PIC interrupt input line
+ * @brief Disable a specified PIC interrupt input line
*
* This routine disables a specified PIC interrupt input line.
*
@@ -309,7 +309,7 @@
/**
*
- * _i8259_irq_enable - enable a specified PIC interrupt input line
+ * @brief Enable a specified PIC interrupt input line
*
* This routine enables a specified PIC interrupt input line.
*
diff --git a/drivers/interrupt_controller/i8259_boi.S b/drivers/interrupt_controller/i8259_boi.S
index 7726b08..410df6d 100644
--- a/drivers/interrupt_controller/i8259_boi.S
+++ b/drivers/interrupt_controller/i8259_boi.S
@@ -61,7 +61,7 @@
/**
*
- * _i8259_boi_master - detect whether it is spurious interrupt or not
+ * @brief Detect whether it is spurious interrupt or not
*
* This routine is called before the user's interrupt handler to detect the
* spurious interrupt on the master PIC. If a spurious interrupt condition is
@@ -95,7 +95,7 @@
/**
*
- * _i8259_boi_slave - detect whether it is spurious interrupt or not
+ * @brief Detect whether it is spurious interrupt or not
*
* This routine is called before the user's interrupt handler to detect the
* spurious interrupt on the slave PIC. If a spurious interrupt condition is
diff --git a/drivers/interrupt_controller/ioapic_intr.c b/drivers/interrupt_controller/ioapic_intr.c
index 3e73c74..eda4904 100644
--- a/drivers/interrupt_controller/ioapic_intr.c
+++ b/drivers/interrupt_controller/ioapic_intr.c
@@ -211,7 +211,7 @@
/**
*
- * _ioapic_init - initialize the IO APIC or xAPIC
+ * @brief Initialize the IO APIC or xAPIC
*
* This routine initializes the IO APIC or xAPIC.
*
@@ -263,7 +263,7 @@
/**
*
- * _ioapic_eoi - send EOI (End Of Interrupt) signal to IO APIC
+ * @brief Send EOI (End Of Interrupt) signal to IO APIC
*
* This routine sends an EOI signal to the IO APIC's interrupting source.
*
@@ -279,7 +279,7 @@
/**
*
- * _ioapic_eoi_get - get EOI (End Of Interrupt) information
+ * @brief Get EOI (End Of Interrupt) information
*
* This routine returns EOI signalling information for a specific IRQ.
*
@@ -319,7 +319,7 @@
/**
*
- * _ioapic_irq_enable - enable a specified APIC interrupt input line
+ * @brief Enable a specified APIC interrupt input line
*
* This routine enables a specified APIC interrupt input line.
*
@@ -334,7 +334,7 @@
/**
*
- * _ioapic_irq_disable - disable a specified APIC interrupt input line
+ * @brief Disable a specified APIC interrupt input line
*
* This routine disables a specified APIC interrupt input line.
*
@@ -349,7 +349,7 @@
/**
*
- * _ioapic_irq_set - programs the interrupt redirection table
+ * @brief Programs the interrupt redirection table
*
* This routine sets up the redirection table entry for the specified IRQ
*
@@ -370,7 +370,7 @@
/**
*
- * _ioapic_int_vec_set - program interrupt vector for specified irq
+ * @brief Program interrupt vector for specified irq
*
* The routine writes the interrupt vector in the Interrupt Redirection
* Table for specified irq number
@@ -388,7 +388,7 @@
/**
*
- * __IoApicGet - read a 32 bit IO APIC register
+ * @brief Read a 32 bit IO APIC register
*
* This routine reads the specified IO APIC register using indirect addressing.
*
@@ -416,7 +416,7 @@
/**
*
- * __IoApicSet - write a 32 bit IO APIC register
+ * @brief Write a 32 bit IO APIC register
*
* This routine writes the specified IO APIC register using indirect addressing.
*
@@ -444,7 +444,7 @@
/**
*
- * ioApicRedGetLo - get low 32 bits of Redirection Table entry
+ * @brief Get low 32 bits of Redirection Table entry
*
* This routine reads the low-order 32 bits of a Redirection Table entry.
*
@@ -470,7 +470,7 @@
/**
*
- * ioApicRedSetLo - set low 32 bits of Redirection Table entry
+ * @brief Set low 32 bits of Redirection Table entry
*
* This routine writes the low-order 32 bits of a Redirection Table entry.
*
@@ -497,7 +497,7 @@
/**
*
- * ioApicRedSetHi - set high 32 bits of Redirection Table entry
+ * @brief Set high 32 bits of Redirection Table entry
*
* This routine writes the high-order 32 bits of a Redirection Table entry.
*
@@ -524,7 +524,7 @@
/**
*
- * _IoApicRedUpdateLo - modify low 32 bits of Redirection Table entry
+ * @brief Modify low 32 bits of Redirection Table entry
*
* This routine modifies selected portions of the low-order 32 bits of a
* Redirection Table entry, as indicated by the associate bit mask.
@@ -550,7 +550,7 @@
/**
*
- * _IoApicRteConfigSet - write to the RTE config register for specified IRQ
+ * @brief Write to the RTE config register for specified IRQ
*
* This routine writes the specified 32-bit <value> into the RTE configuration
* register for the specified <irq> (0 to (IOAPIC_NUM_RTES - 1))
@@ -578,7 +578,7 @@
/**
*
- * _IoApicRedirRegSet - write to the specified MSI redirection register
+ * @brief Write to the specified MSI redirection register
*
* This routine writes the 32-bit <value> into the redirection register
* specified by <reg>.
diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c
index 5460e5c..41722be 100644
--- a/drivers/interrupt_controller/loapic_intr.c
+++ b/drivers/interrupt_controller/loapic_intr.c
@@ -200,7 +200,7 @@
/**
*
- * _loapic_init - initialize the Local APIC or xAPIC
+ * @brief Initialize the Local APIC or xAPIC
*
* This routine initializes Local APIC or xAPIC.
*
@@ -262,7 +262,7 @@
/**
*
- * _loapic_enable - enable the Local xAPIC
+ * @brief Enable the Local xAPIC
*
* This routine enables the Local xAPIC.
*
@@ -280,7 +280,7 @@
/**
*
- * _loapic_disable - disable the Local xAPIC
+ * @brief Disable the Local xAPIC
*
* This routine disables the Local xAPIC.
*
@@ -298,7 +298,7 @@
/**
*
- * _loapic_eoi - send EOI (End Of Interrupt) signal to Local APIC
+ * @brief send EOI (End Of Interrupt) signal to Local APIC
*
* This routine sends an EOI signal to the Local APIC's interrupting source.
*
@@ -313,7 +313,7 @@
/**
*
- * _loapic_int_vec_set - set the vector field in the specified RTE
+ * @brief Set the vector field in the specified RTE
*
* This routine is utilized by the BSP provided routined _SysIntVecAllocate()
* which in turn is provided to support the irq_connect() API. Once
@@ -356,7 +356,7 @@
/**
*
- * _loapic_irq_enable - enable an individual LOAPIC interrupt (IRQ)
+ * @brief Enable an individual LOAPIC interrupt (IRQ)
*
* This routine clears the interrupt mask bit in the LVT for the specified IRQ
*
@@ -386,7 +386,7 @@
/**
*
- * _loapic_irq_disable - disable an individual LOAPIC interrupt (IRQ)
+ * @brief Disable an individual LOAPIC interrupt (IRQ)
*
* This routine clears the interrupt mask bit in the LVT for the specified IRQ
*
diff --git a/drivers/interrupt_controller/system_apic.c b/drivers/interrupt_controller/system_apic.c
index 5c357f8..41a89ce 100644
--- a/drivers/interrupt_controller/system_apic.c
+++ b/drivers/interrupt_controller/system_apic.c
@@ -45,7 +45,7 @@
/**
*
- * _SysIntVecAlloc - allocate interrupt vector
+ * @brief Allocate interrupt vector
*
* This BSP provided routine supports the irq_connect() API. This
* routine is required to perform the following 3 functions:
@@ -63,13 +63,13 @@
*
* The board virtualizes IRQs as follows:
*
- * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC
- * - The remaining IRQs are provided by the LOAPIC.
+ * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC
+ * - The remaining IRQs are provided by the LOAPIC.
*
* Thus, for example, if the IOAPIC supports 24 IRQs:
*
- * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23
- * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows:
+ * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23
+ * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows:
*
* IRQ24 -> LOAPIC_TIMER
* IRQ25 -> LOAPIC_THERMAL
@@ -172,7 +172,7 @@
/**
*
- * _SysIntVecProgram - program interrupt controller
+ * @brief Program interrupt controller
*
* This BSP provided routine programs the appropriate interrupt controller
* with the given vector based on the given IRQ parameter.
@@ -182,9 +182,9 @@
*
* The Clanton board virtualizes IRQs as follows:
*
- * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC
+ * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC
* is programmed for these IRQs
- * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is
+ * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is
* programmed.
*
* The IOAPIC_NUM_RTES macro is provided by board.h, and it specifies the number
@@ -207,7 +207,7 @@
/**
*
- * irq_enable - enable an individual interrupt (IRQ)
+ * @brief Enable an individual interrupt (IRQ)
*
* The public interface for enabling/disabling a specific IRQ for the IA-32
* architecture is defined as follows in include/nanokernel/x86/arch.h
@@ -233,7 +233,7 @@
/**
*
- * irq_disable - disable an individual interrupt (IRQ)
+ * @brief Disable an individual interrupt (IRQ)
*
* The irq_disable() routine is provided by the BSP due to the
* IRQ virtualization that is performed by this BSP. See the comments
diff --git a/drivers/interrupt_controller/system_pic.c b/drivers/interrupt_controller/system_pic.c
index 72e5e4c..c68dcb1 100644
--- a/drivers/interrupt_controller/system_pic.c
+++ b/drivers/interrupt_controller/system_pic.c
@@ -47,7 +47,7 @@
/**
*
- * _SysIntVecAlloc - allocate interrupt vector
+ * @brief Allocate interrupt vector
*
* This BSP provided routine supports the irq_connect() API. This
* routine performs the following functions:
@@ -64,8 +64,8 @@
*
* The pcPentium4 board virtualizes IRQs as follows:
*
- * - IRQ0 to IRQ7 are provided by the master i8259 PIC
- * - IRQ8 to IRQ15 are provided by the slave i8259 PIC
+ * - IRQ0 to IRQ7 are provided by the master i8259 PIC
+ * - IRQ8 to IRQ15 are provided by the slave i8259 PIC
*
* @return the allocated interrupt vector
*
@@ -149,7 +149,7 @@
/**
*
- * _SysIntVecProgram - program interrupt controller
+ * @brief Program interrupt controller
*
* This BSP provided routine programs the appropriate interrupt controller
* with the given vector based on the given IRQ parameter.
