From 6f74dc666e0d9918d59e14dbdbd669f7ec49b337 Mon Sep 17 00:00:00 2001
From: Remy Prechelt <prechelt@hawaii.edu>
Date: Sat, 18 Jul 2020 14:28:38 -1000
Subject: [PATCH] Updated function docstrings (mention smart pointer).
---
.gitlab-ci.yml | 5 -----
Framework/Logging/Logging.h | 6 ++++--
2 files changed, 4 insertions(+), 7 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b2d5028cd..9328bd1c5 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -22,11 +22,6 @@ variables:
# Mote: "WIP:" merge request, non-WIP merge requests and "Ready for Code Review" MR are all
# handled explicitly
#
-
-
-
-# normal multi-step pipeline for each commit
-
stages:
- quality
- config
diff --git a/Framework/Logging/Logging.h b/Framework/Logging/Logging.h
index 24bbc634b..a06756e05 100644
--- a/Framework/Logging/Logging.h
+++ b/Framework/Logging/Logging.h
@@ -46,11 +46,13 @@ namespace corsika::logging {
}
/**
- * Get a reference to a named logger.
+ * Get a smart pointer to an existing logger.
*
- * If the logger does not exist, it is created.
+ * If the logger does not exist, it is created and returned.
*
* @param name The name of the logger to get.
+ * @param defaultlog If True, make this the default logger.
+ * @returns The constructed and formatted logger.
*/
auto GetLogger(std::string const& name, bool const defaultlog = false) {
--
GitLab