Doxygen comments added, as stated in #44 (comment)

HEP-FCC · Sep 25, 2023 · fd78837 · fd78837
1 parent ecf519e
commit fd78837
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/SimG4Components/src/SimG4OpticalPhysicsList.h b/SimG4Components/src/SimG4OpticalPhysicsList.h
@@ -8,6 +8,18 @@
 // FCCSW
 #include "k4Interface/ISimG4PhysicsList.h"
 
+/** @class SimG4OpticalPhysicsList SimG4Components/src/SimG4OpticalPhysicsList.h SimG4OpticalPhysicsList.h
+ *
+ *  FTFP_BERT physics list + Optical photons physics lists tool.
+ *  
+ *  When instantiating the tool three booleans can be passed as arguments:
+ *  --SetCerenkov, default true, to enable Cerenkov process
+ *  --SetScintillation, default true, to enable Scintillation process
+ *  --SetTransitionRadiation, default true, to enable Transition Radiation process
+ *
+ *  @author Alvaro Tolosa-Delgado
+ */
+
 class SimG4OpticalPhysicsList : public AlgTool, virtual public ISimG4PhysicsList {
 public:
   explicit SimG4OpticalPhysicsList(const std::string& aType, const std::string& aName, const IInterface* aParent);