patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

net: trickle: Fix doxygen comments

Browse source 
Add comments to Trickle API documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-20 17:20:30 +02:00 committed by Anas Nashif
parent bf2eb7b65c
commit bc362fa902
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
include/net/trickle.h
View file

@ -32,11 +32,21 @@ extern "C" {
struct net_trickle;
/**
* @typedef net_trickle_cb_t
* @brief Trickle timer callback.
*
* @details The callback is called after Trickle timeout expires.
*
* @param trickle The trickle context to use.
* @param do_suppress Is TX allowed (true) or not (false).
* @param user_data The user data given in net_trickle_start() call.
*/
typedef void (*net_trickle_cb_t)(struct net_trickle *trickle,
bool do_suppress, void *user_data);
/*
* The variable names are taken directly from RFC when applicable.
/**
* The variable names are taken directly from RFC 6206 when applicable.
* Note that the struct members should not be accessed directly but
* only via the Trickle API.
*/
@ -57,7 +67,9 @@ struct net_trickle {
void *user_data;
};
/** @cond INTERNAL_HIDDEN */
#define NET_TRICKLE_INFINITE_REDUNDANCY 0
/** @endcond */
/**
* @brief Create a Trickle timer.