From 7b940a39dfef6f19846fe357d4a5167c66c79e85 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Sat, 8 Dec 2018 11:54:28 +0100
Subject: wanda: extract logging

---
 src/xdg.hpp | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/xdg.hpp')

diff --git a/src/xdg.hpp b/src/xdg.hpp
index b57a34f..8010b7b 100644
--- a/src/xdg.hpp
+++ b/src/xdg.hpp
@@ -9,6 +9,9 @@
 
 namespace wanda
 {
+  /**
+   * @brief An @p enum to represet the standardized XDG directories
+   */
   enum struct xdg_directory : std::underlying_type_t<std::byte>
   {
     data_home,
@@ -17,8 +20,14 @@ namespace wanda
     runtime_dir,
   };
 
+  /**
+   * @brief Get the name of the environment variable associated with the given XDG directory
+   */
   std::string xdg_variable(xdg_directory directory);
 
+  /**
+   * @brief Get the path to the given @p directory given the provided @p environment
+   */
   std::filesystem::path xdg_path_for(xdg_directory directory, environment const & environment);
 }  // namespace wanda
 
-- 
cgit v1.2.3