From: JINMEI Tatuya <jinmei@isc.org>
Date: Tue, 3 Jan 2012 18:12:08 +0000 (-0800)
Subject: [805] some suggested updates to doxgen docs for addServerXXXFromFD: added
X-Git-Tag: trac2351_base~304^2~16^2~16
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=dfe23099c41cc78082d7b5b67cd3a2dcea86c8c6;p=thirdparty%2Fkea.git

[805] some suggested updates to doxgen docs for addServerXXXFromFD: added
assumption on the descriptors; added blank lines for readability.
---

diff --git a/src/lib/asiodns/dns_service.h b/src/lib/asiodns/dns_service.h
index b77b7f7042..66f8d33fed 100644
--- a/src/lib/asiodns/dns_service.h
+++ b/src/lib/asiodns/dns_service.h
@@ -88,11 +88,16 @@ public:
     /// \brief Add another server to the service
     void addServer(uint16_t port, const std::string &address);
     void addServer(const char &port, const std::string &address);
-    /// \brief Add another TCP server/listener to the service from already opened
-    ///    file descriptor
+
+    /// \brief Add another TCP server/listener to the service from already
+    /// opened file descriptor
     ///
     /// Adds a new TCP server using an already opened file descriptor (eg. it
     /// only wraps it so the file descriptor is usable within the event loop).
+    /// The file descriptor must be associated with a TCP socket of the given
+    /// address family that is bound to an appropriate port (and possibly a
+    /// specific address) and is ready for listening to new connection
+    /// requests but has not actually started listening.
     ///
     /// \param fd the file descriptor to be used.
     /// \param af the address family of the file descriptor. Must be either
@@ -101,11 +106,15 @@ public:
     /// \throw isc::asiolink::IOError when a low-level error happens, like the
     ///     fd is not a valid descriptor or it can't be listened on.
     void addServerTCPFromFD(int fd, int af);
+
     /// \brief Add another UDP server to the service from already opened
     ///    file descriptor
     ///
     /// Adds a new UDP server using an already opened file descriptor (eg. it
     /// only wraps it so the file descriptor is usable within the event loop).
+    /// The file descriptor must be associated with a UDP socket of the given
+    /// address family that is bound to an appropriate port (and possibly a
+    /// specific address).
     ///
     /// \param fd the file descriptor to be used.
     /// \param af the address family of the file descriptor. Must be either
@@ -114,6 +123,7 @@ public:
     /// \throw isc::asiolink::IOError when a low-level error happens, like the
     ///     fd is not a valid descriptor or it can't be listened on.
     void addServerUDPFromFD(int fd, int af);
+
     /// \brief Remove all servers from the service
     void clearServers();