Browse Source

[2861] Little bit of documentation

Michal 'vorner' Vaner 11 years ago
parent
commit
e746e58a9f
1 changed files with 9 additions and 0 deletions
  1. 9 0
      src/bin/auth/datasrc_clients_mgr.h

+ 9 - 0
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;
 };