Make sure that labeling is used consistently in all function headers (part 3).

This commit is contained in:
Gregory Nutt 2018-02-01 12:17:03 -06:00
parent 1567b82429
commit 2683f713ab
31 changed files with 35 additions and 70 deletions

View file

@ -111,17 +111,6 @@ extern "C"
#define EXTERN extern #define EXTERN extern
#endif #endif
/****************************************************************************
* Name:
*
* Description:
*
* Input Parameters:
*
* Returned Value:
*
****************************************************************************/
/* Clocking: /* Clocking:
* CLK - This is the main clock of the Cortex-A9 processor. All Cortex-A9 * CLK - This is the main clock of the Cortex-A9 processor. All Cortex-A9
* processors in the Cortex-A9 MPCore processor and the SCU are clocked * processors in the Cortex-A9 MPCore processor and the SCU are clocked

View file

@ -258,7 +258,7 @@ int __ramfunc__ msc_load_verify_address(uint32_t *address)
} }
/**************************************************************************** /****************************************************************************
* Name:msc_load_data * Name: msc_load_data
* *
* Description: * Description:
* Perform data phase of FLASH write cycle. * Perform data phase of FLASH write cycle.

View file

@ -1034,7 +1034,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:sam_tsd_ioctl * Name: sam_tsd_ioctl
****************************************************************************/ ****************************************************************************/
static int sam_tsd_ioctl(struct file *filep, int cmd, unsigned long arg) static int sam_tsd_ioctl(struct file *filep, int cmd, unsigned long arg)

View file

@ -1949,7 +1949,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer)
} }
/**************************************************************************** /****************************************************************************
* Name stm32_ltdc_lclear * Name: stm32_ltdc_lclear
* *
* Description: * Description:
* Clear the whole layer * Clear the whole layer

View file

@ -1959,7 +1959,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer)
} }
/**************************************************************************** /****************************************************************************
* Name stm32_ltdc_lclear * Name: stm32_ltdc_lclear
* *
* Description: * Description:
* Clear the whole layer * Clear the whole layer

View file

@ -308,7 +308,7 @@ static int up_getcursor(FAR struct fb_vtable_s *vtable,
#endif #endif
/**************************************************************************** /****************************************************************************
* Name: * Name: up_setcursor
****************************************************************************/ ****************************************************************************/
#ifdef CONFIG_FB_HWCURSOR #ifdef CONFIG_FB_HWCURSOR

View file

@ -486,7 +486,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:up_ioctl * Name: up_ioctl
****************************************************************************/ ****************************************************************************/
static int up_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int up_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -81,7 +81,7 @@ static struct idt_entry_s idt_entries[256];
****************************************************************************/ ****************************************************************************/
/**************************************************************************** /****************************************************************************
* Name idt_outb * Name: idt_outb
* *
* Description: * Description:
* A slightly slower version of outb * A slightly slower version of outb
@ -94,7 +94,7 @@ static void idt_outb(uint8_t val, uint16_t addr)
} }
/**************************************************************************** /****************************************************************************
* Name up_remappic * Name: up_remappic
* *
* Description: * Description:
* Remap the PIC. The Programmable Interrupt Controller (PIC) is used to * Remap the PIC. The Programmable Interrupt Controller (PIC) is used to
@ -142,7 +142,7 @@ static void up_remappic(void)
} }
/**************************************************************************** /****************************************************************************
* Name up_idtentry * Name: up_idtentry
* *
* Description: * Description:
* Initialize one IDT entry. * Initialize one IDT entry.
@ -168,7 +168,7 @@ static void up_idtentry(unsigned int index, uint32_t base, uint16_t sel,
} }
/**************************************************************************** /****************************************************************************
* Name up_idtinit * Name: up_idtinit
* *
* Description: * Description:
* Initialize the IDT. The Interrupt Descriptor Table (IDT) is a data * Initialize the IDT. The Interrupt Descriptor Table (IDT) is a data

View file

@ -65,7 +65,7 @@ static void idt_outb(uint8_t val, uint16_t addr) noinline_function;
****************************************************************************/ ****************************************************************************/
/**************************************************************************** /****************************************************************************
* Name idt_outb * Name: idt_outb
* *
* Description: * Description:
* A slightly slower version of outb * A slightly slower version of outb

View file

@ -329,7 +329,7 @@ void gpio_matrix_out(uint32_t gpio, uint32_t signal_idx, bool out_inv,
bool oen_inv); bool oen_inv);
/**************************************************************************** /****************************************************************************
* Name: * Name: gpio_pad_select_gpio
* *
* Description: * Description:
* Select pad as a gpio function from IOMUX. * Select pad as a gpio function from IOMUX.

View file

@ -1328,7 +1328,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:tc_ioctl * Name: tc_ioctl
****************************************************************************/ ****************************************************************************/
static int tc_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int tc_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -1197,7 +1197,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:tc_ioctl * Name: tc_ioctl
****************************************************************************/ ****************************************************************************/
static int tc_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int tc_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -331,7 +331,7 @@ int stm32_qencoder_initialize(FAR const char *devpath, int timer);
#endif #endif
/**************************************************************************** /****************************************************************************
* Name stm32_rgbled_setup * Name: stm32_rgbled_setup
* *
* Description: * Description:
* This function is called by board initialization logic to configure the * This function is called by board initialization logic to configure the

View file

@ -720,7 +720,7 @@ int stm32_pca9635_initialize(void);
#endif #endif
/**************************************************************************** /****************************************************************************
* Name stm32_rgbled_setup * Name: stm32_rgbled_setup
* *
* Description: * Description:
* This function is called by board initialization logic to configure the * This function is called by board initialization logic to configure the
@ -761,7 +761,7 @@ int stm32_timer_driver_setup(FAR const char *devpath, int timer);
#endif #endif
/**************************************************************************** /****************************************************************************
* Name xen1210_archinitialize * Name: xen1210_archinitialize
* *
* Description: * Description:
* This function is called by board initialization logic to configure the * This function is called by board initialization logic to configure the

View file

@ -314,7 +314,7 @@ static ssize_t bch_read(FAR struct file *filep, FAR char *buffer, size_t len)
} }
/**************************************************************************** /****************************************************************************
* Name:bch_write * Name: bch_write
****************************************************************************/ ****************************************************************************/
static ssize_t bch_write(FAR struct file *filep, FAR const char *buffer, size_t len) static ssize_t bch_write(FAR struct file *filep, FAR const char *buffer, size_t len)

View file

@ -975,7 +975,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:ads7843e_ioctl * Name: ads7843e_ioctl
****************************************************************************/ ****************************************************************************/
static int ads7843e_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int ads7843e_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -977,7 +977,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:ft5x06_ioctl * Name: ft5x06_ioctl
****************************************************************************/ ****************************************************************************/
static int ft5x06_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int ft5x06_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -981,7 +981,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:max11802_ioctl * Name: max11802_ioctl
****************************************************************************/ ****************************************************************************/
static int max11802_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int max11802_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -1499,7 +1499,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:mxt_ioctl * Name: mxt_ioctl
****************************************************************************/ ****************************************************************************/
static int mxt_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int mxt_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -1029,7 +1029,7 @@ errout:
} }
/**************************************************************************** /****************************************************************************
* Name:tsc2007_ioctl * Name: tsc2007_ioctl
****************************************************************************/ ****************************************************************************/
static int tsc2007_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int tsc2007_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -1189,7 +1189,7 @@ errout_without_sem:
} }
/**************************************************************************** /****************************************************************************
* Name:cc3000_write * Name: cc3000_write
* *
* Bit of non standard buffer management ahead * Bit of non standard buffer management ahead
* The buffer is memory allocated in the user space with space for the spi * The buffer is memory allocated in the user space with space for the spi
@ -1306,7 +1306,7 @@ errout_without_sem:
} }
/**************************************************************************** /****************************************************************************
* Name:cc3000_ioctl * Name: cc3000_ioctl
****************************************************************************/ ****************************************************************************/
static int cc3000_ioctl(FAR struct file *filep, int cmd, unsigned long arg) static int cc3000_ioctl(FAR struct file *filep, int cmd, unsigned long arg)

View file

@ -40,7 +40,7 @@
#include <stdint.h> #include <stdint.h>
/**************************************************************************** /****************************************************************************
* Name:__error__ * Name: __error__
* *
* Description: * Description:
* Stub function for ASSERT macro * Stub function for ASSERT macro

View file

@ -123,15 +123,4 @@ enum spirit_version_e
* Public Function Prototypes * Public Function Prototypes
******************************************************************************/ ******************************************************************************/
/******************************************************************************
* Name:
*
* Description:
*
* Input Parameters:
*
* Returned Value:
*
******************************************************************************/
#endif /* __DRIVERS_WIRELESS_SPIRIT_INCLUDE_SPIRIT_GENERAL_H */ #endif /* __DRIVERS_WIRELESS_SPIRIT_INCLUDE_SPIRIT_GENERAL_H */

View file

@ -102,7 +102,7 @@ uint8_t spirit_fifo_get_txcount(FAR struct spirit_library_s *spirit)
} }
/****************************************************************************** /******************************************************************************
* Name: * Name: spirit_fifo_set_rxalmostfull
* *
* Description: * Description:
* Sets the almost full threshold for the Rx FIFO. When the number of * Sets the almost full threshold for the Rx FIFO. When the number of

View file

@ -146,7 +146,7 @@ int hex2bin(FAR struct lib_instream_s *instream,
uint32_t endpaddr, enum hex2bin_swap_e swap); uint32_t endpaddr, enum hex2bin_swap_e swap);
/**************************************************************************** /****************************************************************************
* Name hex2mem * Name: hex2mem
* *
* Description: * Description:
* Read the Intel HEX ASCII data provided on the file descriptor 'fd' and * Read the Intel HEX ASCII data provided on the file descriptor 'fd' and
@ -173,7 +173,7 @@ int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr,
enum hex2bin_swap_e swap); enum hex2bin_swap_e swap);
/**************************************************************************** /****************************************************************************
* Name fhex2mem * Name: fhex2mem
* *
* Description: * Description:
* Read the Intel HEX ASCII data provided on the standard stream * Read the Intel HEX ASCII data provided on the standard stream

View file

@ -393,7 +393,7 @@ void net_setipid(uint16_t id);
int net_checksd(int fd, int oflags); int net_checksd(int fd, int oflags);
/**************************************************************************** /****************************************************************************
* Name: * Name: net_initlist
* *
* Description: * Description:
* Initialize a list of sockets for a new task * Initialize a list of sockets for a new task

View file

@ -295,7 +295,7 @@ int nx_runinstance(FAR const char *mqname, FAR NX_DRIVERTYPE *dev);
int nx_start(void); int nx_start(void);
/**************************************************************************** /****************************************************************************
* Name:nx_connectinstance (and nx_connect macro) * Name: nx_connectinstance (and nx_connect macro)
* *
* Description: * Description:
* Open a connection from a client to the NX server. One one client * Open a connection from a client to the NX server. One one client

View file

@ -52,7 +52,7 @@
****************************************************************************/ ****************************************************************************/
/**************************************************************************** /****************************************************************************
* Name fhex2mem * Name: fhex2mem
* *
* Description: * Description:
* Read the Intel HEX ASCII data provided on the standard stream * Read the Intel HEX ASCII data provided on the standard stream

View file

@ -52,7 +52,7 @@
****************************************************************************/ ****************************************************************************/
/**************************************************************************** /****************************************************************************
* Name hex2mem * Name: hex2mem
* *
* Description: * Description:
* Read the Intel HEX ASCII data provided on the file descriptor 'fd' and * Read the Intel HEX ASCII data provided on the file descriptor 'fd' and

View file

@ -51,7 +51,7 @@
****************************************************************************/ ****************************************************************************/
/**************************************************************************** /****************************************************************************
* Name: * Name: wcsnrtombs
* *
* Description: * Description:
* The 'wcsrtombs' function converts a string of wide characters * The 'wcsrtombs' function converts a string of wide characters

View file

@ -530,7 +530,7 @@ static int local_connect(FAR struct socket *psock,
} }
/**************************************************************************** /****************************************************************************
* Name: pkt_accept * Name: local_accept
* *
* Description: * Description:
* The pkt_accept function is used with connection-based socket types * The pkt_accept function is used with connection-based socket types
@ -799,17 +799,4 @@ static int local_close(FAR struct socket *psock)
* Public Functions * Public Functions
****************************************************************************/ ****************************************************************************/
/****************************************************************************
* Name:
*
* Description:
*
* Parameters:
*
* Returned Value:
*
* Assumptions:
*
****************************************************************************/
#endif /* CONFIG_NET_LOCAL */ #endif /* CONFIG_NET_LOCAL */