]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2470] completed doc for RRCollator::AddRRsetCallback.
authorJINMEI Tatuya <jinmei@isc.org>
Wed, 12 Dec 2012 18:52:37 +0000 (10:52 -0800)
committerJINMEI Tatuya <jinmei@isc.org>
Wed, 12 Dec 2012 18:52:37 +0000 (10:52 -0800)
src/lib/dns/rrcollator.h

index d4f5a1be48d0fbbb3a70cee0792cf1ac6c21e2e8..6028c076839a9a3c5b9609ce76b0f43fad9b9dc8 100644 (file)
@@ -52,7 +52,13 @@ namespace dns {
 /// the class.
 class RRCollator : boost::noncopyable {
 public:
-    /// \brief
+    /// \brief Callback functor type for \c RRCollator.
+    ///
+    /// This type of callback is given to an \c RRCollator object on its
+    /// construction, and will be called for each collated RRset built in
+    /// the \c RRCollator.
+    ///
+    /// \param rrset The collated RRset.
     typedef boost::function<void(const RRsetPtr& rrset)> AddRRsetCallback;
 
     /// \brief Constructor.