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

(limited to 'src/logging.hpp')

diff --git a/src/logging.hpp b/src/logging.hpp
index 46432b8..b3c1665 100644
--- a/src/logging.hpp
+++ b/src/logging.hpp
@@ -1,3 +1,9 @@
+/**
+ * @file   logging.hpp
+ * @author Felix Morgner (felix.morgner@gmail.com)
+ * @since  1.0.0
+ */
+
 #ifndef WANDA_LOGGING_HPP
 #define WANDA_LOGGING_HPP
 
@@ -8,10 +14,21 @@
 
 namespace wanda
 {
+  /**
+   * @brief A covenience alias to represent a handle for a logger
+   */
   using logger_ptr = std::shared_ptr<spdlog::logger>;
 
+  /**
+   * @brief Initialize the shared logger
+   * 
+   * @note The logger will only ever be initialized once, even if this function is called multiple times
+   */
   void initialize_logger(spdlog::sink_ptr sink = std::make_shared<spdlog::sinks::null_sink_st>());
 
+  /**
+   * @brief Get the shared logger
+   */
   logger_ptr get_logger();
 }  // namespace wanda
 
-- 
cgit v1.2.3