docs(sim): Add comment to FairRunSim::SetMCConfig()

Comments explain `SetMCConfig()` functionality.
karabowi · Aug 28, 2024 · 00898f9 · 00898f9
1 parent 9bf292c
commit 00898f9
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/fairroot/base/steer/FairRunSim.h b/fairroot/base/steer/FairRunSim.h
@@ -226,6 +226,12 @@ class FairRunSim : public FairRun
   private:
     FairRunSim(const FairRunSim& M);
     FairRunSim& operator=(const FairRunSim&) { return *this; }
+    /**
+     * Performs simulation initialization:
+     * - runs simulation config (construct TGeant3/TGeant4, configure TGeant3/TGeant4, create stack),
+     * - runs FairMCApplication->InitMC() (set stack, run fMC->Init(), run fMC->BuildPhysics()),
+     * - runs postinit config (sets some VMC properties, which are only allowed after init).
+     */
     void SetMCConfig();
     void CheckFlukaExec();