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

4
doc/reference/networking/can_transceiver.svg
View file

@ -465,8 +465,8 @@
<use xlink:href="#glyph0-11" x="99.944079" y="187.725"/> <use xlink:href="#glyph0-11" x="99.944079" y="187.725"/>
<use xlink:href="#glyph0-10" x="104.773449" y="187.725"/> <use xlink:href="#glyph0-10" x="104.773449" y="187.725"/>
</g> </g>
<path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,0%,0%);stroke-opacity:1;stroke-miterlimit:10;" d="M -0.000125 0.851313 L 25.511594 0.851313 L 25.511594 26.363031 L 76.538938 26.363031 L 76.538938 0.851313 L 102.050656 0.851313 " transform="matrix(1,0,0,-1,14.047,235.906)"/> <path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,0%,0%);stroke-opacity:1;stroke-miterlimit:10;" d="M -0.000125 25.511469 L 25.511594 25.511469 L 25.511594 0.851313 L 76.538938 0.851313 L 76.538938 25.511469 L 102.050656 25.511469 " transform="matrix(1,0,0,-1,14.047,235.906)"/>
<path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(0%,0%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 1.699094 0.851313 L 27.214719 0.851313 L 27.214719 26.363031 L 78.238156 26.363031 L 78.238156 0.851313 L 103.749875 0.851313 " transform="matrix(1,0,0,-1,14.047,235.906)"/> <path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(0%,0%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 1.699094 25.511469 L 27.214719 25.511469 L 27.214719 0.851313 L 78.238156 0.851313 L 78.238156 25.511469 L 103.749875 25.511469 " transform="matrix(1,0,0,-1,14.047,235.906)"/>
<path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(0%,0%,0%);stroke-opacity:1;stroke-miterlimit:10;" d="M 105.287188 59.360844 L 105.412188 59.36475 M 105.295 59.36475 L 126.560625 59.368656 M 126.560625 59.368656 L 147.818438 59.36475 M 147.697344 59.36475 L 147.818438 59.36475 M 105.287188 42.692875 L 105.412188 42.696781 M 105.295 42.696781 L 126.560625 42.696781 M 126.560625 42.696781 L 147.818438 42.696781 M 147.697344 42.696781 L 147.818438 42.696781 M 64.806719 51.028813 L 62.935625 51.028813 M 39.123125 51.028813 L 39.005938 51.028813 M 39.123125 51.028813 L 34.873125 51.032719 M 34.873125 51.032719 L 30.619219 51.028813 M 30.740313 51.028813 L 30.619219 51.028813 M 136.072344 98.142094 L 136.072344 102.056156 M 136.072344 71.950688 L 136.080156 71.8335 M 136.080156 71.954594 L 136.091875 65.579594 M 136.091875 65.579594 L 136.080156 59.196781 M 136.080156 59.317875 L 136.080156 59.196781 M 136.072344 30.106938 L 136.080156 30.228031 M 136.080156 30.106938 L 136.091875 36.48975 M 136.091875 36.48975 L 136.080156 42.86475 M 136.080156 42.743656 L 136.080156 42.86475 M 110.552813 85.040531 L 119.404375 85.044438 M 110.552813 76.536625 L 119.056719 76.536625 L 119.056719 17.009281 L 119.404375 17.009281 M 78.662188 80.798344 L 84.927813 80.794438 M 39.970781 80.790531 L 39.853594 80.794438 M 39.970781 80.794438 L 35.720781 80.798344 M 35.720781 80.798344 L 31.466875 80.794438 M 31.587969 80.794438 L 31.466875 80.794438 " transform="matrix(1,0,0,-1,140.205,263.396)"/> <path style="fill:none;stroke-width:0.3985;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(0%,0%,0%);stroke-opacity:1;stroke-miterlimit:10;" d="M 105.287188 59.360844 L 105.412188 59.36475 M 105.295 59.36475 L 126.560625 59.368656 M 126.560625 59.368656 L 147.818438 59.36475 M 147.697344 59.36475 L 147.818438 59.36475 M 105.287188 42.692875 L 105.412188 42.696781 M 105.295 42.696781 L 126.560625 42.696781 M 126.560625 42.696781 L 147.818438 42.696781 M 147.697344 42.696781 L 147.818438 42.696781 M 64.806719 51.028813 L 62.935625 51.028813 M 39.123125 51.028813 L 39.005938 51.028813 M 39.123125 51.028813 L 34.873125 51.032719 M 34.873125 51.032719 L 30.619219 51.028813 M 30.740313 51.028813 L 30.619219 51.028813 M 136.072344 98.142094 L 136.072344 102.056156 M 136.072344 71.950688 L 136.080156 71.8335 M 136.080156 71.954594 L 136.091875 65.579594 M 136.091875 65.579594 L 136.080156 59.196781 M 136.080156 59.317875 L 136.080156 59.196781 M 136.072344 30.106938 L 136.080156 30.228031 M 136.080156 30.106938 L 136.091875 36.48975 M 136.091875 36.48975 L 136.080156 42.86475 M 136.080156 42.743656 L 136.080156 42.86475 M 110.552813 85.040531 L 119.404375 85.044438 M 110.552813 76.536625 L 119.056719 76.536625 L 119.056719 17.009281 L 119.404375 17.009281 M 78.662188 80.798344 L 84.927813 80.794438 M 39.970781 80.790531 L 39.853594 80.794438 M 39.970781 80.794438 L 35.720781 80.798344 M 35.720781 80.798344 L 31.466875 80.794438 M 31.587969 80.794438 L 31.466875 80.794438 " transform="matrix(1,0,0,-1,140.205,263.396)"/>
<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> <g style="fill:rgb(0%,0%,0%);fill-opacity:1;">
<use xlink:href="#glyph4-1" x="237.4194" y="219.211"/> <use xlink:href="#glyph4-1" x="237.4194" y="219.211"/>

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 128 KiB

After

Width:  |  Height:  |  Size: 128 KiB

Before After
Before After

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 * @param filter Pointer to a zcan_filter structure defining the id
* filtering. * filtering.
* *
* @retval filter id on success. * @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left. * @retval CAN_NO_FREE_FILTER if there is no filter left.
*/ */
int can_attach_workq(struct device *dev, struct k_work_q *work_q, 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 * @param filter Pointer to a zcan_filter structure defining the id
* filtering. * filtering.
* *
* @retval filter id on success. * @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left. * @retval CAN_NO_FREE_FILTER if there is no filter left.
*/ */
__syscall int can_attach_msgq(struct device *dev, struct k_msgq *msg_q, __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 * @param filter Pointer to a zcan_filter structure defining the id
* filtering. * filtering.
* *
* @retval filter id on success. * @retval filter_id on success.
* @retval CAN_NO_FREE_FILTER if there is no filter left. * @retval CAN_NO_FREE_FILTER if there is no filter left.
*/ */
static inline int can_attach_isr(struct device *dev, static inline int can_attach_isr(struct device *dev,