michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doxygen: add @brief and capitalize

Browse source 
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>
This commit is contained in:
Anas Nashif 2015-07-01 17:51:40 -04:00
commit f367f071b6
223 changed files with 1146 additions and 1147 deletions
Download patch file Download diff file Expand all files Collapse all files

10
drivers/pci/pci.c
View file

@ -169,7 +169,7 @@ static struct lookup_data __noinit lookup;
/**
*
* pci_get_bar_config - return the configuration for the specified BAR
* @brief Return the configuration for the specified BAR
*
* @return 0 if BAR is implemented, -1 if not.
*/
@ -214,7 +214,7 @@ static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr,
/**
*
* pci_bar_params_get - retrieve the I/O address and IRQ of the specified BAR
* @brief Retrieve the I/O address and IRQ of the specified BAR
*
* @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved
*
@ -265,7 +265,7 @@ static inline int pci_bar_params_get(union pci_addr_reg pci_ctrl_addr,
/**
*
* pci_dev_scan - scan the specified PCI device for all sub functions
* @brief Scan the specified PCI device for all sub functions
*
* @return 1 if a device has been found, 0 otherwise.
*
@ -376,7 +376,7 @@ void pci_bus_scan_init(void)
/**
*
* pci_bus_scan - scans PCI bus for devices
* @brief Scans PCI bus for devices
*
* The routine scans the PCI bus for the devices on criterias provided in the
* given dev_info at first call. Which criterias can be class and/or
@ -430,7 +430,7 @@ int pci_bus_scan(struct pci_dev_info *dev_info)
#ifdef CONFIG_PCI_DEBUG
/**
*
* pci_show - Show PCI device
* @brief Show PCI device
*
* Shows the PCI device found provided as parameter.
*

14
drivers/pci/pci_config.c
View file

@ -54,7 +54,7 @@ This module implements the PCI config space access functions
/**
*
* pci_config_out_long - write a 32bit data to pci reg in offset
* @brief Write a 32bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number
@ -84,7 +84,7 @@ void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_out_word - write a 16bit data to pci reg in offset
* @brief Write a 16bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@ -114,7 +114,7 @@ void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_out_byte - write a 8bit data to pci reg in offset
* @brief Write a 8bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@ -144,7 +144,7 @@ void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_in_long - read a 32bit data from pci reg in offset
* @brief Read a 32bit data from pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@ -175,7 +175,7 @@ void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_in_word - read in a 16bit data from a pci reg in offset
* @brief Read in a 16bit data from a pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@ -212,7 +212,7 @@ void pci_config_in_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_in_byte - read in a 8bit data from a pci reg in offset
* @brief Read in a 8bit data from a pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@ -249,7 +249,7 @@ void pci_config_in_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
/**
*
* pci_config_ext_cap_ptr_find - find extended capability in ECP linked list
* @brief Find extended capability in ECP linked list
*
* This routine searches for an extended capability in the linked list of
* capabilities in config space. If found, the offset of the first byte

16
drivers/pci/pci_interface.c
View file

@ -54,7 +54,7 @@ This module implements the PCI H/W access functions.
/**
*
* pci_ctrl_read - read a PCI controller register
* @brief Read a PCI controller register
*
* This routine reads the specified register from the PCI controller and
* places the data into the provided buffer.
@ -88,7 +88,7 @@ static void pci_ctrl_read(uint32_t reg, /* PCI register to read */
/**
*
* pci_ctrl_write - write a PCI controller register
* @brief Write a PCI controller register
*
* This routine writes the provided data to the specified register in the PCI
* controller.
@ -123,7 +123,7 @@ static void pci_ctrl_write(uint32_t reg, /* PCI register to write */
/**
*
* pci_ctrl_data_read - read the PCI controller data register
* @brief Read the PCI controller data register
*
* This routine reads the data register of the specified PCI controller.
*
@ -149,7 +149,7 @@ static int pci_ctrl_data_read(uint32_t controller, /* controller number */
/**
*
* pci_ctrl_data_write - write the PCI controller data register
* @brief Write the PCI controller data register
*
* This routine writes the provided data to the data register of the
* specified PCI controller.
@ -176,7 +176,7 @@ static int pci_ctrl_data_write(uint32_t controller, /* controller number */
/**
*
* pci_ctrl_addr_write - write the PCI controller address register
* @brief Write the PCI controller address register
*
* This routine writes the provided data to the address register of the
* specified PCI controller.
@ -202,7 +202,7 @@ static int pci_ctrl_addr_write(uint32_t controller, /* controller number */
/**
*
* pci_read - read a PCI register from a device
* @brief Read a PCI register from a device
*
* This routine reads data from a PCI device's configuration space. The
* device and register to read is specified by the address parameter ("addr")
@ -292,7 +292,7 @@ void pci_read(uint32_t controller, /* PCI controller to use */
/**
*
* pci_write - write a to a PCI register
* @brief Write a to a PCI register
*
* This routine writes data to a PCI device's configuration space. The
* device and register to write is specified by the address parameter ("addr")
@ -381,7 +381,7 @@ void pci_write(uint32_t controller, /* controller to use */
/**
*
* pci_header_get - get the PCI header for a device
* @brief Get the PCI header for a device
*
* This routine reads the PCI header for the specified device and puts the
* result in the supplied header structure.