From 20371c1e1c9b188cc4a712bd9e2fbcade4f6f2a5 Mon Sep 17 00:00:00 2001
From: ralfulrich <ralf.ulrich@kit.edu>
Date: Tue, 13 Apr 2021 17:52:57 +0200
Subject: [PATCH] better comments
---
corsika/framework/process/NullModel.hpp | 4 ++--
corsika/framework/utility/COMBoost.hpp | 2 +-
corsika/framework/utility/SaveBoostHistogram.hpp | 1 +
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/corsika/framework/process/NullModel.hpp b/corsika/framework/process/NullModel.hpp
index eb39f870e..cdaa3753e 100644
--- a/corsika/framework/process/NullModel.hpp
+++ b/corsika/framework/process/NullModel.hpp
@@ -18,7 +18,7 @@ namespace corsika {
@{
Process that does nothing. It is not even derived from
- BaseProcess
+ BaseProcess. But it can be added to a ProcessSequence.
*/
class NullModel {
@@ -30,7 +30,7 @@ namespace corsika {
static bool const is_process_sequence = false;
static bool const is_switch_process_sequence = false;
- //! Default number of processes is just one, obviously
+ //! Default number of processes is zero, obviously
static unsigned int constexpr getNumberOfProcesses() { return 0; }
};
diff --git a/corsika/framework/utility/COMBoost.hpp b/corsika/framework/utility/COMBoost.hpp
index 43a123cf1..eac8dde53 100644
--- a/corsika/framework/utility/COMBoost.hpp
+++ b/corsika/framework/utility/COMBoost.hpp
@@ -25,7 +25,7 @@ namespace corsika {
**/
/**
- @class
+ @class COMBoost
@ingroup Utilities
This utility class handles Lorentz boost between different
diff --git a/corsika/framework/utility/SaveBoostHistogram.hpp b/corsika/framework/utility/SaveBoostHistogram.hpp
index 30cbdda2a..16e39180c 100644
--- a/corsika/framework/utility/SaveBoostHistogram.hpp
+++ b/corsika/framework/utility/SaveBoostHistogram.hpp
@@ -13,6 +13,7 @@
namespace corsika {
/**
+ * @file SaveBoostHistogram.hpp
* @ingroup Utilities
*
* This functions saves a boost::histogram into a numpy file. Only rather basic axis
--
GitLab