From d3e691c9200b7b782c8acf17468068a699588a73 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Mon, 10 Dec 2018 09:25:14 +0100
Subject: doc: update documentation

---
 src/commander.hpp | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'src/commander.hpp')

diff --git a/src/commander.hpp b/src/commander.hpp
index 131022d..42a2ab6 100644
--- a/src/commander.hpp
+++ b/src/commander.hpp
@@ -15,8 +15,15 @@
 
 namespace wanda
 {
+  /**
+   * @brief The remote control client
+   * 
+   */
   struct commander : wanda::control_connection::listener
   {
+    /**
+     * @brief The interface to be implemented by remote control listeners
+     */
     struct listener
     {
       virtual void on_connected(commander & commander){};
@@ -24,10 +31,24 @@ namespace wanda
       virtual void on_error(commander & commander, std::string error){};
     };
 
+    /**
+     * @brief Construct a new commander
+     */
     commander(asio::io_service & service, std::filesystem::path socket, listener & listener);
 
+    /**
+     * @brief Start communication with the remote daemon endpoint
+     */
     void start();
+
+    /**
+     * @brief Stop communication with the remote daemon endpoint
+     */
     void stop();
+
+    /**
+     * @brief Send a command to the remote daemon endpoint
+     */
     void send(command command);
 
     void on_error(control_connection::pointer connection, std::error_code error) override;
-- 
cgit v1.2.3