Browse Source

More review comments

git-svn-id: svn://bind10.isc.org/svn/bind10/branches/trac327@3311 e5f2f494-b856-4b98-b285-d166d9295462
Evan Hunt 14 years ago
parent
commit
9c4cc9eb2f
2 changed files with 31 additions and 2 deletions
  1. 16 1
      src/bin/auth/auth_srv.h
  2. 15 1
      src/bin/recurse/recursor.h

+ 16 - 1
src/bin/auth/auth_srv.h

@@ -56,12 +56,27 @@ public:
     //@}
 
     /// \brief Process an incoming DNS message, then signal 'server' to resume 
+    ///
+    /// A DNS query (or other message) has been received by a \c DNSServer
+    /// object.  Find an answer, then post the \c DNSServer object on the
+    /// I/O service queue and return.  When the server resumes, it can
+    /// send the reply.
+    ///
+    /// \param io_message The I/O service queue
+    /// \param message Pointer to the \c Message object
+    /// \param buffer Pointer to an \c OutputBuffer for the resposne
+    /// \param server Pointer to the \c DNSServer
     void processMessage(const asiolink::IOMessage& io_message,
                         isc::dns::MessagePtr message,
                         isc::dns::OutputBufferPtr buffer,
                         asiolink::DNSServer* server);
-    // \brief Set and get verbose mode
+
+    /// \brief Set verbose flag
+    ///
+    /// \param on The new value of the verbose flag
     void setVerbose(bool on);
+
+    /// \brief Get the current value of the verbose flag
     bool getVerbose() const;
 
     /// \brief Set and get the config session

+ 15 - 1
src/bin/recurse/recursor.h

@@ -48,13 +48,27 @@ public:
     //@}
 
     /// \brief Process an incoming DNS message, then signal 'server' to resume 
+    ///
+    /// A DNS query (or other message) has been received by a \c DNSServer
+    /// object.  Find an answer, then post the \c DNSServer object on the
+    /// I/O service queue and return.  When the server resumes, it can
+    /// send the reply.
+    ///
+    /// \param io_message The I/O service queue
+    /// \param message Pointer to the \c Message object
+    /// \param buffer Pointer to an \c OutputBuffer for the resposne
+    /// \param server Pointer to the \c DNSServer
     void processMessage(const asiolink::IOMessage& io_message,
                         isc::dns::MessagePtr message,
                         isc::dns::OutputBufferPtr buffer,
                         asiolink::DNSServer* server);
 
-    // \brief Set and get verbose mode
+    /// \brief Set verbose flag
+    ///
+    /// \param on The new value of the verbose flag
     void setVerbose(bool on);
+
+    /// \brief Get the current value of the verbose flag
     bool getVerbose() const;
 
     /// \brief Set and get the config session