From 05f4479366e35aba59d9380ab1a0229eb731ff6d Mon Sep 17 00:00:00 2001
From: Andre Sailer <andre.philippe.sailer@cern.ch>
Date: Tue, 10 Mar 2020 10:29:39 +0100
Subject: [PATCH] HepMC3FileReader: add documentation and caveat

---
 DDG4/hepmc/HepMC3FileReader.cpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/DDG4/hepmc/HepMC3FileReader.cpp b/DDG4/hepmc/HepMC3FileReader.cpp
index 67fa3fd0f..2a9a47b2a 100644
--- a/DDG4/hepmc/HepMC3FileReader.cpp
+++ b/DDG4/hepmc/HepMC3FileReader.cpp
@@ -16,7 +16,10 @@
   \package HepMC3FileReader
  * \brief Plugin to read HepMC3 files
  *
- And here we can put a longer description, parameters, examples...
+ * The HepMC3 File reader uses the HepMC3 Reader Factory to open any HepMC3 compatible file.
+ *
+ * However, it was only tested on HepMC3 ascii files produced by Whizard 2.8.2, so please use it carefully, and validate
+ * its conversion carefully before extensive usage.
  *
 @}
  */
-- 
GitLab