From 48efc92fee45b6f6402fd124bee4af3732c08237 Mon Sep 17 00:00:00 2001 From: "Alfred E. Heggestad" Date: Sun, 15 May 2022 10:50:48 +0200 Subject: [PATCH] update doxygen comments --- include/re_thread.h | 9 ++++++++- src/sipsess/connect.c | 3 ++- src/trice/candpair.c | 2 +- src/trice/chklist.c | 4 ++-- 4 files changed, 13 insertions(+), 5 deletions(-) diff --git a/include/re_thread.h b/include/re_thread.h index 870193ec2..854984b76 100644 --- a/include/re_thread.h +++ b/include/re_thread.h @@ -75,6 +75,9 @@ int thrd_create(thrd_t *thr, thrd_start_t func, void *arg); /** * Checks whether `lhs` and `rhs` refer to the same thread. * + * @param lhs Left hand side thread + * @param rhs Right hand side thread + * * @return Non-zero value if lhs and rhs refer to the same value, 0 otherwise. */ int thrd_equal(thrd_t lhs, thrd_t rhs); @@ -82,6 +85,8 @@ int thrd_equal(thrd_t lhs, thrd_t rhs); /** * Return the identifier of the calling thread. + * + * @return Current thread */ thrd_t thrd_current(void); @@ -89,6 +94,8 @@ thrd_t thrd_current(void); /** * Detaches the thread identified by `thr` from the current environment. * + * @param thr Thread + * * @return 0 if success, otherwise errorcode */ int thrd_detach(thrd_t thr); @@ -161,7 +168,7 @@ int cnd_broadcast(cnd_t *cnd); * Blocks on a condition variable * * @param cnd Pointer to condition variable - * @param lock Lock mutex pointer + * @param mtx Lock mutex pointer * * @return 0 if success, otherwise errorcode */ diff --git a/src/sipsess/connect.c b/src/sipsess/connect.c index 9c17eaa1d..31856a4ff 100644 --- a/src/sipsess/connect.c +++ b/src/sipsess/connect.c @@ -195,10 +195,11 @@ static int invite(struct sipsess *sess) * @param routev Outbound route vector * @param routec Outbound route vector count * @param ctype Session content-type - * @param desc Content description (e.g. SDP) * @param authh SIP Authentication handler * @param aarg Authentication handler argument * @param aref True to mem_ref() aarg + * @param callid Call Identifier + * @param desch Content description handler * @param offerh Session offer handler * @param answerh Session answer handler * @param progrh Session progress handler diff --git a/src/trice/candpair.c b/src/trice/candpair.c index ff0c02c0d..265929533 100644 --- a/src/trice/candpair.c +++ b/src/trice/candpair.c @@ -137,7 +137,7 @@ int trice_candpair_alloc(struct ice_candpair **cpp, struct trice *icem, } -/** Computing Pair Priority and Ordering Pairs */ +/* Computing Pair Priority and Ordering Pairs */ void trice_candpair_prio_order(struct list *lst, bool controlling) { struct le *le; diff --git a/src/trice/chklist.c b/src/trice/chklist.c index 4d6a2c654..11b50cc36 100644 --- a/src/trice/chklist.c +++ b/src/trice/chklist.c @@ -152,7 +152,7 @@ bool trice_checklist_iscompleted(const struct trice *icem) } -/** +/* * Scheduling Checks */ void trice_conncheck_schedule_check(struct trice *icem) @@ -200,7 +200,7 @@ void trice_conncheck_schedule_check(struct trice *icem) } -/** +/* * Computing States */ void trice_checklist_set_waiting(struct trice *icem)