aboutsummaryrefslogtreecommitdiff
path: root/src/xdg.hpp
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@gmail.com>2018-12-08 11:54:28 +0100
committerFelix Morgner <felix.morgner@gmail.com>2018-12-08 11:54:28 +0100
commit7b940a39dfef6f19846fe357d4a5167c66c79e85 (patch)
treee83fef50b0125ff8034305d71821d6857522d60a /src/xdg.hpp
parent0c1d1a0f24655c22a373c19aac90a6a225a353e6 (diff)
downloadwanda-7b940a39dfef6f19846fe357d4a5167c66c79e85.tar.xz
wanda-7b940a39dfef6f19846fe357d4a5167c66c79e85.zip
wanda: extract logging
Diffstat (limited to 'src/xdg.hpp')
-rw-r--r--src/xdg.hpp9
1 files changed, 9 insertions, 0 deletions
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