From 98bdb96757d320cc4bf2e624400cdb4ea36b7f76 Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@tu-dortmund.de>
Date: Fri, 7 May 2021 19:33:55 +0200
Subject: [PATCH] documentation
---
corsika/framework/process/IntLengthModifyingProcess.hpp | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/corsika/framework/process/IntLengthModifyingProcess.hpp b/corsika/framework/process/IntLengthModifyingProcess.hpp
index 6507ba70c..ab1e4e3ad 100644
--- a/corsika/framework/process/IntLengthModifyingProcess.hpp
+++ b/corsika/framework/process/IntLengthModifyingProcess.hpp
@@ -35,6 +35,10 @@ namespace corsika {
//! energy
using functor_signature = GrammageType(GrammageType, corsika::Code, HEPEnergyType);
+ /**
+ * Create wrapper around InteractionProcess. Note that the passed process object
+ * itself may no longer be used, only through this class.
+ */
IntLengthModifyingProcess(TUnderlyingProcess&& process,
std::function<functor_signature> modifier);
@@ -46,6 +50,7 @@ namespace corsika {
template <typename TParticle>
GrammageType getInteractionLength(TParticle const& particle);
+ ///! obtain reference to wrapped process
TUnderlyingProcess const& getProcess() const;
TUnderlyingProcess& getProcess();
--
GitLab