usb: remove @return doc for void functions
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:
parent
bae4847b51
commit
c955a44f13
5 changed files with 2 additions and 31 deletions
|
@ -404,8 +404,6 @@ int usb_transfer_sync(uint8_t ep, uint8_t *data, size_t dlen, unsigned int flags
|
||||||
*
|
*
|
||||||
* @param[in] ep Endpoint address corresponding to the one
|
* @param[in] ep Endpoint address corresponding to the one
|
||||||
* listed in the device configuration table
|
* listed in the device configuration table
|
||||||
*
|
|
||||||
* @return 0 on success, negative errno code on fail.
|
|
||||||
*/
|
*/
|
||||||
void usb_cancel_transfer(uint8_t ep);
|
void usb_cancel_transfer(uint8_t ep);
|
||||||
|
|
||||||
|
|
|
@ -127,8 +127,6 @@ int webusb_vendor_handle_req(struct usb_setup_packet *pSetup,
|
||||||
* for handling the device requests.
|
* for handling the device requests.
|
||||||
*
|
*
|
||||||
* @param [in] handlers Pointer to WebUSB request handlers structure
|
* @param [in] handlers Pointer to WebUSB request handlers structure
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
void webusb_register_request_handlers(struct webusb_req_handlers *handlers)
|
void webusb_register_request_handlers(struct webusb_req_handlers *handlers)
|
||||||
{
|
{
|
||||||
|
@ -161,8 +159,6 @@ done:
|
||||||
* @brief Callback used to know the USB connection status
|
* @brief Callback used to know the USB connection status
|
||||||
*
|
*
|
||||||
* @param status USB device status code.
|
* @param status USB device status code.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void webusb_dev_status_cb(struct usb_cfg_data *cfg,
|
static void webusb_dev_status_cb(struct usb_cfg_data *cfg,
|
||||||
enum usb_dc_status_code status,
|
enum usb_dc_status_code status,
|
||||||
|
|
|
@ -35,8 +35,6 @@ struct webusb_req_handlers {
|
||||||
* for handling requests.
|
* for handling requests.
|
||||||
*
|
*
|
||||||
* @param [in] handlers Pointer to WebUSB request handlers structure
|
* @param [in] handlers Pointer to WebUSB request handlers structure
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
void webusb_register_request_handlers(struct webusb_req_handlers *handlers);
|
void webusb_register_request_handlers(struct webusb_req_handlers *handlers);
|
||||||
|
|
||||||
|
|
|
@ -299,8 +299,6 @@ done:
|
||||||
*
|
*
|
||||||
* @param ep Endpoint address.
|
* @param ep Endpoint address.
|
||||||
* @param ep_status Endpoint status code.
|
* @param ep_status Endpoint status code.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_int_in(uint8_t ep, enum usb_dc_ep_cb_status_code ep_status)
|
static void cdc_acm_int_in(uint8_t ep, enum usb_dc_ep_cb_status_code ep_status)
|
||||||
{
|
{
|
||||||
|
@ -442,8 +440,6 @@ static void cdc_interface_config(struct usb_desc_header *head,
|
||||||
* IRQ.
|
* IRQ.
|
||||||
*
|
*
|
||||||
* @param work Address of work item.
|
* @param work Address of work item.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_callback_work_handler(struct k_work *work)
|
static void cdc_acm_irq_callback_work_handler(struct k_work *work)
|
||||||
{
|
{
|
||||||
|
@ -549,8 +545,6 @@ static int cdc_acm_fifo_read(const struct device *dev, uint8_t *rx_data,
|
||||||
* @brief Enable TX interrupt
|
* @brief Enable TX interrupt
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_tx_enable(const struct device *dev)
|
static void cdc_acm_irq_tx_enable(const struct device *dev)
|
||||||
{
|
{
|
||||||
|
@ -567,8 +561,6 @@ static void cdc_acm_irq_tx_enable(const struct device *dev)
|
||||||
* @brief Disable TX interrupt
|
* @brief Disable TX interrupt
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_tx_disable(const struct device *dev)
|
static void cdc_acm_irq_tx_disable(const struct device *dev)
|
||||||
{
|
{
|
||||||
|
@ -599,8 +591,6 @@ static int cdc_acm_irq_tx_ready(const struct device *dev)
|
||||||
* @brief Enable RX interrupt
|
* @brief Enable RX interrupt
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_rx_enable(const struct device *dev)
|
static void cdc_acm_irq_rx_enable(const struct device *dev)
|
||||||
{
|
{
|
||||||
|
@ -617,8 +607,6 @@ static void cdc_acm_irq_rx_enable(const struct device *dev)
|
||||||
* @brief Disable RX interrupt
|
* @brief Disable RX interrupt
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_rx_disable(const struct device *dev)
|
static void cdc_acm_irq_rx_disable(const struct device *dev)
|
||||||
{
|
{
|
||||||
|
@ -684,8 +672,6 @@ static int cdc_acm_irq_update(const struct device *dev)
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
* @param cb Callback function pointer.
|
* @param cb Callback function pointer.
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_irq_callback_set(const struct device *dev,
|
static void cdc_acm_irq_callback_set(const struct device *dev,
|
||||||
uart_irq_callback_user_data_t cb,
|
uart_irq_callback_user_data_t cb,
|
||||||
|
@ -722,8 +708,6 @@ int cdc_acm_dte_rate_callback_set(const struct device *dev,
|
||||||
*
|
*
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
* @param baudrate Baud rate.
|
* @param baudrate Baud rate.
|
||||||
*
|
|
||||||
* @return N/A.
|
|
||||||
*/
|
*/
|
||||||
static void cdc_acm_baudrate_set(const struct device *dev, uint32_t baudrate)
|
static void cdc_acm_baudrate_set(const struct device *dev, uint32_t baudrate)
|
||||||
{
|
{
|
||||||
|
@ -741,7 +725,8 @@ static void cdc_acm_baudrate_set(const struct device *dev, uint32_t baudrate)
|
||||||
* @param dev CDC ACM device struct.
|
* @param dev CDC ACM device struct.
|
||||||
* @param ep_status Endpoint status code.
|
* @param ep_status Endpoint status code.
|
||||||
*
|
*
|
||||||
* @return N/A.
|
* @retval 0 on success.
|
||||||
|
* @retval -EIO if timed out.
|
||||||
*/
|
*/
|
||||||
static int cdc_acm_send_notification(const struct device *dev,
|
static int cdc_acm_send_notification(const struct device *dev,
|
||||||
uint16_t serial_state)
|
uint16_t serial_state)
|
||||||
|
|
|
@ -232,8 +232,6 @@ static bool usb_handle_request(struct usb_setup_packet *setup,
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* @brief send next chunk of data (possibly 0 bytes) to host
|
* @brief send next chunk of data (possibly 0 bytes) to host
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
static void usb_data_to_host(void)
|
static void usb_data_to_host(void)
|
||||||
{
|
{
|
||||||
|
@ -274,8 +272,6 @@ static void usb_data_to_host(void)
|
||||||
*
|
*
|
||||||
* @param [in] ep Endpoint address
|
* @param [in] ep Endpoint address
|
||||||
* @param [in] ep_status Endpoint status
|
* @param [in] ep_status Endpoint status
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
static void usb_handle_control_transfer(uint8_t ep,
|
static void usb_handle_control_transfer(uint8_t ep,
|
||||||
enum usb_dc_ep_cb_status_code ep_status)
|
enum usb_dc_ep_cb_status_code ep_status)
|
||||||
|
@ -398,8 +394,6 @@ static void usb_handle_control_transfer(uint8_t ep,
|
||||||
*
|
*
|
||||||
* @param [in] type Type of request, e.g. USB_REQTYPE_TYPE_STANDARD
|
* @param [in] type Type of request, e.g. USB_REQTYPE_TYPE_STANDARD
|
||||||
* @param [in] handler Callback function pointer
|
* @param [in] handler Callback function pointer
|
||||||
*
|
|
||||||
* @return N/A
|
|
||||||
*/
|
*/
|
||||||
static void usb_register_request_handler(int32_t type,
|
static void usb_register_request_handler(int32_t type,
|
||||||
usb_request_handler handler)
|
usb_request_handler handler)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue