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/command.hpp | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'src/command.hpp')

diff --git a/src/command.hpp b/src/command.hpp
index 37afaae..afc6a6f 100644
--- a/src/command.hpp
+++ b/src/command.hpp
@@ -9,21 +9,36 @@
 
 namespace wanda
 {
+  /**
+   * @brief An enum to describe different command IDs
+   */
   enum struct command_id : char
   {
-    change,
+    change,  //< Change the wallpaper
   };
 
+  /**
+   * @brief A simple type to represent commands transported through the control connection
+   */
   struct command
   {
     command_id const id;
     std::vector<std::string> const arguments;
 
+    /**
+     * @brief Convert the command to a message for transmission to a remote endpoint
+     */
     std::optional<wanda::message> message() const;
   };
 
+  /**
+   * @brief Extract a command from a message
+   */
   std::optional<command> make_command(message message);
 
+  /**
+   * @brief A simple factory to create a "Change wallpaper" command
+   */
   command make_change_command();
 
 }  // namespace wanda
-- 
cgit v1.2.3