From: Mukund Sivaraman <muks@isc.org>
Date: Thu, 13 Jun 2013 08:11:01 +0000 (+0530)
Subject: [2853] Update constructor documentation
X-Git-Tag: bind10-1.2.0beta1-release~399^2~9
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bd74cbbdfc7828d5517089d1c9d4f2768b7bc7de;p=thirdparty%2Fkea.git

[2853] Update constructor documentation
---

diff --git a/src/lib/datasrc/client_list.h b/src/lib/datasrc/client_list.h
index 6fd4bb336c..2880e56bd5 100644
--- a/src/lib/datasrc/client_list.h
+++ b/src/lib/datasrc/client_list.h
@@ -81,7 +81,8 @@ class DataSourceStatus {
 public:
     /// \brief Constructor
     ///
-    /// Sets initial values.
+    /// Sets initial values. If you want to use \c SEGMENT_UNUSED as the
+    /// state, please use the other constructor.
     DataSourceStatus(const std::string& name, MemorySegmentState state,
                      const std::string& type) :
         name_(name),
@@ -94,8 +95,8 @@ public:
 
     /// \brief Constructor
     ///
-    /// Sets initial values. The state is set as SEGMENT_UNUSED and the
-    /// type is effectively unspecified.
+    /// Sets initial values. The state is set as \c SEGMENT_UNUSED and
+    /// the type is effectively unspecified.
     DataSourceStatus(const std::string& name) :
         name_(name),
         type_(""),