ice: update doxygen comments (#113)

src/ice/cand.c

@@ -231,6 +231,11 @@ struct ice_cand *icem_cand_find(const struct list *lst, unsigned compid,
 
 /**
  * Find the highest priority LCAND on the check-list of type HOST/RELAY
+ *
+ * @param icem    ICE Media object
+ * @param compid  Component ID
+ *
+ * @return Local candidate if found, otherwise NULL
  */
 struct ice_cand *icem_lcand_find_checklist(const struct icem *icem,
 					   unsigned compid)

src/ice/candpair.c

@@ -147,7 +147,11 @@ int icem_candpair_clone(struct ice_candpair **cpp, struct ice_candpair *cp0,
 }
 
 
-/** Computing Pair Priority and Ordering Pairs */
+/**
+ * Computing Pair Priority and Ordering Pairs
+ *
+ * @param lst Checklist (struct ice_candpair)
+ */
 void icem_candpair_prio_order(struct list *lst)
 {
 	struct le *le;
@@ -222,6 +226,10 @@ void icem_candpair_set_state(struct ice_candpair *cp,
 
 /**
  * Delete all Candidate-Pairs where the Local candidate is of a given type
+ *
+ * @param lst     Checklist or Validlist
+ * @param type    Candidate type
+ * @param compid  Component ID
  */
 void icem_candpairs_flush(struct list *lst, enum ice_cand_type type,
 			  unsigned compid)
@@ -357,6 +365,11 @@ struct ice_candpair *icem_candpair_find_compid(const struct list *lst,
 
 /**
  * Find a remote candidate in the checklist or validlist
+ *
+ * @param icem    ICE Media object
+ * @param rcand   Remote candidate
+ *
+ * @return Candidate pair if found, otherwise NULL
  */
 struct ice_candpair *icem_candpair_find_rcand(struct icem *icem,
 					  const struct ice_cand *rcand)

src/ice/chklist.c

@@ -109,6 +109,8 @@ static void candpair_prune(struct icem *icem)
 
 /**
  * Computing States
+ *
+ * @param icem    ICE Media object
  */
 void ice_candpair_set_states(struct icem *icem)
 {
@@ -239,6 +241,8 @@ static void concluding_ice(struct icem_comp *comp)
 
 /**
  * Check List and Timer State Updates
+ *
+ * @param icem    ICE Media object
  */
 void icem_checklist_update(struct icem *icem)
 {

src/ice/connchk.c

@@ -335,6 +335,8 @@ static void do_check(struct ice_candpair *cp)
 
 /**
  * Scheduling Checks
+ *
+ * @param icem    ICE Media object
  */
 void icem_conncheck_schedule_check(struct icem *icem)
 {
@@ -382,6 +384,10 @@ static void pace_timeout(void *arg)
 
 /**
  * Scheduling Checks
+ *
+ * @param icem    ICE Media object
+ *
+ * @return 0 if success, otherwise errorcode
  */
 int icem_conncheck_start(struct icem *icem)
 {
@@ -419,6 +425,9 @@ void icem_conncheck_continue(struct icem *icem)
 
 /**
  * Stop checklist, cancel all connectivity checks
+ *
+ * @param icem    ICE Media object
+ * @param err     Error code
  */
 void icem_conncheck_stop(struct icem *icem, int err)
 {

src/ice/icem.c

@@ -284,7 +284,11 @@ static void *unique_handler(struct le *le1, struct le *le2)
 }
 
 
-/** Eliminating Redundant Candidates */
+/**
+ * Eliminating Redundant Candidates
+ *
+ * @param icem    ICE Media object
+ */
 void icem_cand_redund_elim(struct icem *icem)
 {
 	uint32_t n;