michaelh/zephyr
1
0
Fork 0
Code Releases Activity

include: drivers: CAN: changed return parameter description

Browse source 
Changed return parameter description from
"@retval filter id on success"  to
"@retval filter_id on success".
This change suppresses the doxy warnings.

Signed-off-by: Alexander Wachter <alexander.wachter@student.tugraz.at>
This commit is contained in:
Alexander Wachter 2019-09-01 17:10:12 +02:00 • committed by Anas Nashif
commit 1c7892df3f
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/drivers/can.h
View file

@ -374,7 +374,7 @@ static inline int can_write(struct device *dev, const u8_t *data, u8_t length,
* @param filter Pointer to a zcan_filter structure defining the id
* filtering.
*
* @retval filter id on success.
* @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left.
*/
int can_attach_workq(struct device *dev, struct k_work_q *work_q,
@ -398,7 +398,7 @@ int can_attach_workq(struct device *dev, struct k_work_q *work_q,
* @param filter Pointer to a zcan_filter structure defining the id
* filtering.
*
* @retval filter id on success.
* @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left.
*/
__syscall int can_attach_msgq(struct device *dev, struct k_msgq *msg_q,
@ -420,7 +420,7 @@ __syscall int can_attach_msgq(struct device *dev, struct k_msgq *msg_q,
* @param filter Pointer to a zcan_filter structure defining the id
* filtering.
*
* @retval filter id on success.
* @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left.
*/
static inline int can_attach_isr(struct device *dev,