From: Michal 'vorner' Vaner <michal.vaner@nic.cz>
Date: Wed, 10 Jul 2013 07:19:18 +0000 (+0200)
Subject: [2861] Little bit of documentation
X-Git-Tag: bind10-1.2.0beta1-release~343^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e746e58a9fec019dd8a944baeed75c685a6cdf28;p=thirdparty%2Fkea.git

[2861] Little bit of documentation
---

diff --git a/src/bin/auth/datasrc_clients_mgr.h b/src/bin/auth/datasrc_clients_mgr.h
index 2a54dcf014..33698cc3f1 100644
--- a/src/bin/auth/datasrc_clients_mgr.h
+++ b/src/bin/auth/datasrc_clients_mgr.h
@@ -94,14 +94,23 @@ typedef boost::function<void ()> FinishedCallback;
 /// This just holds the data items together, no logic or protection
 /// is present here.
 struct Command {
+    /// \brief Constructor
+    ///
+    /// It just initializes the member variables of the same names
+    /// as the parameters.
     Command(CommandID id, const data::ConstElementPtr& params,
             const FinishedCallback& callback) :
         id(id),
         params(params),
         callback(callback)
     {}
+    /// \brief The command to execute
     CommandID id;
+    /// \brief Argument of the command.
+    ///
+    /// If the command takes no argument, it should be null pointer.
     data::ConstElementPtr params;
+    /// \brief A callback to be called once the command finishes.
     FinishedCallback callback;
 };