BIND 10 trac805, updated. dfe23099c41cc78082d7b5b67cd3a2dcea86c8c6 [805] some suggested updates to doxgen docs for addServerXXXFromFD: added assumption on the descriptors; added blank lines for readability.

[BIND 10 source code commits]

The branch, trac805 has been updated
       via  dfe23099c41cc78082d7b5b67cd3a2dcea86c8c6 (commit)
      from  5ec29b7633767f56675930402ccc7a7b9a1fdd2d (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit dfe23099c41cc78082d7b5b67cd3a2dcea86c8c6
Author: JINMEI Tatuya <jinmei at isc.org>
Date:   Tue Jan 3 10:12:08 2012 -0800

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

-----------------------------------------------------------------------

Summary of changes:
 src/lib/asiodns/dns_service.h |   14 ++++++++++++--
 1 files changed, 12 insertions(+), 2 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/asiodns/dns_service.h b/src/lib/asiodns/dns_service.h
index b77b7f7..66f8d33 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();