Mercurial > pidgin3 / changeset

--- a/libpurple/stun.h	Sun Aug 28 17:13:12 2016 -0500
+++ b/libpurple/stun.h	Sun Aug 28 17:13:24 2016 -0500
@@ -28,9 +28,9 @@
  * @title: STUN API
  */
 
-/**************************************************************************/
-/* STUN API                                                               */
-/**************************************************************************/
+/******************************************************************************
+ * STUN API
+ *****************************************************************************/
 
 typedef struct _PurpleStunNatDiscovery PurpleStunNatDiscovery;
 
@@ -40,6 +40,8 @@
  * @PURPLE_STUN_STATUS_UNKNOWN: No STUN server reachable
  * @PURPLE_STUN_STATUS_DISCOVERING: The request has been sent to the server
  * @PURPLE_STUN_STATUS_DISCOVERED: The server has responded
+ *
+ * The status of a #PurpleStunNatDiscovery
  */
 typedef enum {
 	PURPLE_STUN_STATUS_UNDISCOVERED = -1,
@@ -48,6 +50,17 @@
 	PURPLE_STUN_STATUS_DISCOVERED
 } PurpleStunStatus;
 
+/**
+ * PurpleStunNatType:
+ * @PURPLE_STUN_NAT_TYPE_PUBLIC_IP: No NAT
+ * @PURPLE_STUN_NAT_TYPE_UNKNOWN_NAT: NAT is unknown
+ * @PURPLE_STUN_NAT_TYPE_FULL_CONE: NAT is a full cone
+ * @PURPLE_STUN_NAT_TYPE_RESTRICTED_CONE: NAT is a restricted cone
+ * @PURPLE_STUN_NAT_TYPE_PORT_RESTRICTED_CONE: NAT is a port restricted cone
+ * @PURPLE_STUN_NAT_TYPE_SYMMETRIC: NAT is symmetric
+ *
+ * The type of NAT that was discovered.
+ */
 typedef enum {
 	PURPLE_STUN_NAT_TYPE_PUBLIC_IP,
 	PURPLE_STUN_NAT_TYPE_UNKNOWN_NAT,
@@ -57,6 +70,16 @@
 	PURPLE_STUN_NAT_TYPE_SYMMETRIC
 } PurpleStunNatType;
 
+/**
+ * PurpleStunNatDiscovery:
+ * @status: The #PurpleStunStatus
+ * @type: The #PurpleStunNatType
+ * @publicip: The public ip
+ * @servername: The name of the stun server
+ * @lookup_time: The time when the lookup occurred.
+ *
+ * A data type representing a STUN lookup.
+ */
 struct _PurpleStunNatDiscovery {
 	PurpleStunStatus status;
 	PurpleStunNatType type;
@@ -79,7 +102,7 @@
  * is already done. Otherwise the callback is called when the discovery is over
  * and NULL is returned.
  *
- * Returns: a PurpleStunNatDiscovery which includes the public IP and the type
+ * Returns: a #PurpleStunNatDiscovery which includes the public IP and the type
  *         of NAT or NULL is discovery would block
  */
 PurpleStunNatDiscovery *purple_stun_discover(PurpleStunCallback cb);