summaryrefslogtreecommitdiff
path: root/agent/candidate.h
diff options
context:
space:
mode:
authorYouness Alaoui <kakaroto@kakaroto.(none)>2008-10-30 19:29:16 -0400
committerYouness Alaoui <kakaroto@kakaroto.(none)>2008-10-30 19:29:16 -0400
commit79a555bb60df4102328b2e897524b9eeb088a015 (patch)
tree81a7126bb2d9af41f0b7c7aadea2de074af9375d /agent/candidate.h
parentd0cec2376d3217741061e6ac06e9eb66f68e45e0 (diff)
downloadlibnice-79a555bb60df4102328b2e897524b9eeb088a015.tar.gz
Update the docs to include everything
Diffstat (limited to 'agent/candidate.h')
-rw-r--r--agent/candidate.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/agent/candidate.h b/agent/candidate.h
index 0133bf0..64eda59 100644
--- a/agent/candidate.h
+++ b/agent/candidate.h
@@ -43,8 +43,13 @@
/**
* SECTION:candidate
* @short_description: ICE candidate representation
+ * @see_also: #NiceAddress
+ * @stability: Stable
*
- *
+ * A representation of an ICE candidate. Make sure you read the ICE drafts[1] to
+ * understand correctly the concept of ICE candidates.
+ *
+ * [1] http://tools.ietf.org/wg/mmusic/draft-ietf-mmusic-ice/
*/
@@ -206,7 +211,8 @@ gfloat
nice_candidate_msn_priority (NiceCandidate *candidate);
guint32
-nice_candidate_ice_priority_full (guint type_pref, guint local_pref, guint component_id);
+nice_candidate_ice_priority_full (guint type_pref, guint local_pref,
+ guint component_id);
guint32
nice_candidate_ice_priority (const NiceCandidate *candidate);