[svn] Add docs for address_list_release.

diff --git a/src/host.c b/src/host.c
index eb0897cdf20da455c641f8edec9d31085abb6dbc..1f538c8b1ebffa1bc9644627b2c7dd5a11e66a3b 100644 (file)
--- a/src/host.c
+++ b/src/host.c
@@ -201,17 +201,10 @@ address_list_connected_p (const struct address_list *al)
 }
 
 #ifdef ENABLE_IPV6
-/**
-  * address_list_from_addrinfo
-  *
-  * This function transform an addrinfo links list in and address_list.
-  *
-  * Input:
-  * addrinfo*          Linked list of addrinfo
-  *
-  * Output:
-  * address_list*      New allocated address_list
-  */
+
+/* Create an address_list from the addresses in the given struct
+   addrinfo.  */
+
 static struct address_list *
 address_list_from_addrinfo (const struct addrinfo *ai)
 {
@@ -256,7 +249,9 @@ address_list_from_addrinfo (const struct addrinfo *ai)
   assert (ip - al->addresses == cnt);
   return al;
 }
-#else
+
+#else  /* not ENABLE_IPV6 */
+
 /* Create an address_list from a NULL-terminated vector of IPv4
    addresses.  This kind of vector is returned by gethostbyname.  */
 
@@ -284,7 +279,8 @@ address_list_from_ipv4_addresses (char **vec)
 
   return al;
 }
-#endif
+
+#endif /* not ENABLE_IPV6 */
 
 static void
 address_list_delete (struct address_list *al)
@@ -293,6 +289,10 @@ address_list_delete (struct address_list *al)
   xfree (al);
 }
 
+/* Mark the address list as being no longer in use.  This will reduce
+   its reference count which will cause the list to be freed when the
+   count reaches 0.  */
+
 void
 address_list_release (struct address_list *al)
 {