riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

conn_can_raw: improve doc

Browse Source
This commit is contained in:
Vincent Dupont 2017-10-11 09:52:44 +02:00
parent d251456585
commit e8e20882ce
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sys/include/can/conn/raw.h
View File

@ -72,6 +72,8 @@ typedef struct conn_can_raw {
* @param[in] ifnum can device Interface * @param[in] ifnum can device Interface
* @param[in] flags conn flags to set (CONN_CAN_RECVONLY) * @param[in] flags conn flags to set (CONN_CAN_RECVONLY)
* *
* @post @p filter must remain allocated until @p conn is closed
*
* @return 0 if socket was successfully connected * @return 0 if socket was successfully connected
* @return any other negative number in case of an error * @return any other negative number in case of an error
*/ */
@ -123,6 +125,10 @@ int conn_can_raw_send(conn_can_raw_t *conn, const struct can_frame *frame, int f
* @param[in] filter list of filters to set * @param[in] filter list of filters to set
* @param[in] count number of filters in @p filter * @param[in] count number of filters in @p filter
* *
* @pre previously set filters must be allocated until the end of the call
* @post @p filter must remain allocated until @p conn is closed or
* conn_can_raw_set_filter() is called
*
* @return 0 if can filters were successfully set * @return 0 if can filters were successfully set
* @return any other negative number in case of an error * @return any other negative number in case of an error
*/ */