From bc362fa9022af09198983c7dc70ab51997efeb96 Mon Sep 17 00:00:00 2001 From: Jukka Rissanen Date: Wed, 20 Feb 2019 17:20:30 +0200 Subject: [PATCH] net: trickle: Fix doxygen comments Add comments to Trickle API documentation. Signed-off-by: Jukka Rissanen --- include/net/trickle.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/include/net/trickle.h b/include/net/trickle.h index e7ca1ab4db..4f32c839ed 100644 --- a/include/net/trickle.h +++ b/include/net/trickle.h @@ -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.