diff options
| author | Felix Morgner <felix.morgner@gmail.com> | 2018-12-10 09:25:14 +0100 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@gmail.com> | 2018-12-10 09:25:14 +0100 |
| commit | d3e691c9200b7b782c8acf17468068a699588a73 (patch) | |
| tree | 44f179ebf773dc8536b220f2ffcc3d2eec374aa4 /src/command.hpp | |
| parent | 7b940a39dfef6f19846fe357d4a5167c66c79e85 (diff) | |
| download | wanda-d3e691c9200b7b782c8acf17468068a699588a73.tar.xz wanda-d3e691c9200b7b782c8acf17468068a699588a73.zip | |
doc: update documentation
Diffstat (limited to 'src/command.hpp')
| -rw-r--r-- | src/command.hpp | 17 |
1 files changed, 16 insertions, 1 deletions
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 |
