From 64d357e21fd88d4426275bd6e101f21903d91e5e Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@tu-dortmund.de>
Date: Fri, 22 Jan 2021 14:53:02 +0100
Subject: [PATCH] documentation
---
corsika/framework/utility/SaveBoostHistogram.hpp | 3 +++
1 file changed, 3 insertions(+)
diff --git a/corsika/framework/utility/SaveBoostHistogram.hpp b/corsika/framework/utility/SaveBoostHistogram.hpp
index c99ab54bb..90a5621bd 100644
--- a/corsika/framework/utility/SaveBoostHistogram.hpp
+++ b/corsika/framework/utility/SaveBoostHistogram.hpp
@@ -19,6 +19,9 @@ namespace corsika {
*
* Note that this function makes a temporary, dense copy of the histogram, which could
* be an issue for huge sizes (e.g. for high dimensions)
+ *
+ * @param overwrite silently overwrite existing files if true, otherwise throw
+ * runtime_error
*/
template <class Axes, class Storage>
inline void save_hist(boost::histogram::histogram<Axes, Storage> const& h,
--
GitLab