Skip to content

Commit

Permalink
update doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alfredh authored and sreimers committed May 15, 2022
1 parent 9215b13 commit 48efc92
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
9 changes: 8 additions & 1 deletion include/re_thread.h
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,27 @@ 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);


/**
* Return the identifier of the calling thread.
*
* @return Current thread
*/
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);
Expand Down Expand Up @@ -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
*/
Expand Down
3 changes: 2 additions & 1 deletion src/sipsess/connect.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/trice/candpair.c
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/trice/chklist.c
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ bool trice_checklist_iscompleted(const struct trice *icem)
}


/**
/*
* Scheduling Checks
*/
void trice_conncheck_schedule_check(struct trice *icem)
Expand Down Expand Up @@ -200,7 +200,7 @@ void trice_conncheck_schedule_check(struct trice *icem)
}


/**
/*
* Computing States
*/
void trice_checklist_set_waiting(struct trice *icem)
Expand Down

0 comments on commit 48efc92

Please sign in to comment.