Browse Source

[3329] ioReady methods were missing commentary in dhcp_ddns.

Adding missing commentary in ncr_io.h and ncr_upd.h
Thomas Markwalder 11 years ago
parent
commit
72d3277877
2 changed files with 6 additions and 0 deletions
  1. 3 0
      src/lib/dhcp_ddns/ncr_io.h
  2. 3 0
      src/lib/dhcp_ddns/ncr_udp.h

+ 3 - 0
src/lib/dhcp_ddns/ncr_io.h

@@ -576,6 +576,9 @@ public:
     /// @throw NcrSenderError if the sender is not in send mode,
     virtual int getSelectFd() = 0;
 
+    /// @brief Returns whether or not the sender has IO ready to process.
+    ///
+    /// @return true if the sender has at IO ready, false otherwise.
     virtual bool ioReady() = 0;
 
 protected:

+ 3 - 0
src/lib/dhcp_ddns/ncr_udp.h

@@ -542,6 +542,9 @@ public:
     /// @throw NcrSenderError if the sender is not in send mode,
     virtual int getSelectFd();
 
+    /// @brief Returns whether or not the sender has IO ready to process.
+    ///
+    /// @return true if the sender has at IO ready, false otherwise.
     virtual bool ioReady();
 
 private: