From a0c7bd9be000392e2d20c4b72a86aab871b42e5e Mon Sep 17 00:00:00 2001
From: Markus Frank <markus.frank@cern.ch>
Date: Thu, 11 Dec 2014 19:51:16 +0000
Subject: [PATCH] Improve the doxygen documentation
---
DDEve/include/DDEve/Annotation.h | 9 +-
DDEve/include/DDEve/Calo2DProjection.h | 14 +-
DDEve/include/DDEve/Calo3DProjection.h | 14 +-
DDEve/include/DDEve/CaloLego.h | 14 +-
DDEve/include/DDEve/DD4hepMenu.h | 13 +-
DDEve/include/DDEve/DDEveEventData.h | 14 +-
DDEve/include/DDEve/DDG4EventHandler.h | 11 +-
DDEve/include/DDEve/Display.h | 13 +-
DDEve/include/DDEve/DisplayConfiguration.h | 14 +-
DDEve/include/DDEve/ElementList.h | 22 +--
.../DDEve/EvePgonSetProjectedContextMenu.h | 13 +-
DDEve/include/DDEve/EveShapeContextMenu.h | 13 +-
DDEve/include/DDEve/EveUserContextMenu.h | 13 +-
DDEve/include/DDEve/EventControl.h | 14 +-
DDEve/include/DDEve/EventHandler.h | 7 +-
DDEve/include/DDEve/Factories.h | 8 +-
DDEve/include/DDEve/FrameControl.h | 13 +-
DDEve/include/DDEve/GenericEventHandler.h | 9 +-
DDEve/include/DDEve/HitActors.h | 146 +++++++++---------
DDEve/include/DDEve/MultiView.h | 14 +-
DDEve/include/DDEve/ParticleActors.h | 54 ++++---
DDEve/include/DDEve/PopupMenu.h | 14 +-
DDEve/include/DDEve/Projection.h | 13 +-
DDEve/include/DDEve/RhoPhiProjection.h | 13 +-
DDEve/include/DDEve/RhoZProjection.h | 13 +-
DDEve/include/DDEve/Utilities.h | 4 +-
DDEve/include/DDEve/View.h | 13 +-
DDEve/include/DDEve/View3D.h | 13 +-
DDEve/include/DDEve/ViewMenu.h | 13 +-
29 files changed, 263 insertions(+), 275 deletions(-)
diff --git a/DDEve/include/DDEve/Annotation.h b/DDEve/include/DDEve/Annotation.h
index ec02d2da8..a8df29f76 100644
--- a/DDEve/include/DDEve/Annotation.h
+++ b/DDEve/include/DDEve/Annotation.h
@@ -16,17 +16,16 @@
class TEveViewer;
class TGLOvlSelectRecord;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
/// Class to add annotations to eve viewers
/**
* Implements slightly larger text size and one line constructor
*
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class Annotation : public TGLAnnotation {
public:
diff --git a/DDEve/include/DDEve/Calo2DProjection.h b/DDEve/include/DDEve/Calo2DProjection.h
index bc95b7a1d..ee85ce171 100644
--- a/DDEve/include/DDEve/Calo2DProjection.h
+++ b/DDEve/include/DDEve/Calo2DProjection.h
@@ -14,19 +14,19 @@
#include "DDEve/Projection.h"
#include "DDEve/Display.h"
+// Forward declarations
class TH2F;
class TEveCalo3D;
class TEveCaloDataHist;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class Calo2DProjection Calo2DProjection.h DDEve/Calo2DProjection.h
- *
- * @author M.Frank
- * @version 1.0
+ /// 2D projection operator for calorimeters
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class Calo2DProjection : public Projection {
public:
diff --git a/DDEve/include/DDEve/Calo3DProjection.h b/DDEve/include/DDEve/Calo3DProjection.h
index 9b1002513..72f84d41f 100644
--- a/DDEve/include/DDEve/Calo3DProjection.h
+++ b/DDEve/include/DDEve/Calo3DProjection.h
@@ -14,19 +14,19 @@
#include "DDEve/View.h"
#include "DDEve/Display.h"
+// Forward declarations
class TH2F;
class TEveCalo3D;
class TEveCaloDataHist;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class Calo3DProjection Calo3DProjection.h DDEve/Calo3DProjection.h
- *
- * @author M.Frank
- * @version 1.0
+ /// 3D projection for calorimeters
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class Calo3DProjection : public View {
public:
diff --git a/DDEve/include/DDEve/CaloLego.h b/DDEve/include/DDEve/CaloLego.h
index 405c7fe17..906aa57b6 100644
--- a/DDEve/include/DDEve/CaloLego.h
+++ b/DDEve/include/DDEve/CaloLego.h
@@ -14,19 +14,19 @@
#include "DDEve/View.h"
#include "DDEve/Display.h"
+// Forward declarations
class TH2F;
class TEveCalo3D;
class TEveCaloDataHist;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class CaloLego CaloLego.h DDEve/CaloLego.h
- *
- * @author M.Frank
- * @version 1.0
+ /// Lego plot for calorimeter energy deposits
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class CaloLego : public View {
Display::CalodataContext m_data;
diff --git a/DDEve/include/DDEve/DD4hepMenu.h b/DDEve/include/DDEve/DD4hepMenu.h
index 388777f47..eba39e3d6 100644
--- a/DDEve/include/DDEve/DD4hepMenu.h
+++ b/DDEve/include/DDEve/DD4hepMenu.h
@@ -17,19 +17,18 @@
class TGMenuBar;
class TGMenuEntry;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class View;
class EventControl;
- /** @class DD4hepMenu DD4hepMenu.h DDEve/DD4hepMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// DD4hep Menu for the ROOT browser
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class DD4hepMenu : public PopupMenu {
public:
diff --git a/DDEve/include/DDEve/DDEveEventData.h b/DDEve/include/DDEve/DDEveEventData.h
index d15d8ac09..d562e0246 100644
--- a/DDEve/include/DDEve/DDEveEventData.h
+++ b/DDEve/include/DDEve/DDEveEventData.h
@@ -13,15 +13,14 @@
#include <vector>
#include <set>
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
/// DDEve event classes: Basic hit
/**
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class DDEveHit {
public:
@@ -46,8 +45,9 @@ namespace DD4hep {
/// Data structure to store the MC particle information
/**
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class DDEveParticle {
public:
diff --git a/DDEve/include/DDEve/DDG4EventHandler.h b/DDEve/include/DDEve/DDG4EventHandler.h
index 136c09b97..5d7f65b97 100644
--- a/DDEve/include/DDEve/DDG4EventHandler.h
+++ b/DDEve/include/DDEve/DDG4EventHandler.h
@@ -21,15 +21,14 @@ class TTree;
class TFile;
class TBranch;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class DDG4EventHandler DDG4EventHandler.h DDEve/DDG4EventHandler.h
+ /** Event I/O handler class for the DD4hep event display
*
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class DDG4EventHandler : public EventHandler {
public:
diff --git a/DDEve/include/DDEve/Display.h b/DDEve/include/DDEve/Display.h
index 259523425..05f6cc372 100644
--- a/DDEve/include/DDEve/Display.h
+++ b/DDEve/include/DDEve/Display.h
@@ -30,9 +30,7 @@ class TGMenuBar;
class TGClient;
class TFile;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
@@ -45,10 +43,11 @@ namespace DD4hep {
class GenericEventHandler;
class DisplayConfiguration;
- /** The main class of the DDEve display.
- *
- * @author M.Frank
- * @version 1.0
+ /// The main class of the DDEve display.
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class Display : public EventConsumer {
public:
diff --git a/DDEve/include/DDEve/DisplayConfiguration.h b/DDEve/include/DDEve/DisplayConfiguration.h
index dadf0d84c..b401fcd1f 100644
--- a/DDEve/include/DDEve/DisplayConfiguration.h
+++ b/DDEve/include/DDEve/DisplayConfiguration.h
@@ -18,19 +18,17 @@
#include <list>
#include <map>
-
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class Display;
- /** @class DisplayConfiguration DisplayConfiguration.h DDEve/DisplayConfiguration.h
- *
- * @author M.Frank
- * @version 1.0
+ /// DisplayConfiguration DisplayConfiguration.h DDEve/DisplayConfiguration.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class DisplayConfiguration {
protected:
diff --git a/DDEve/include/DDEve/ElementList.h b/DDEve/include/DDEve/ElementList.h
index e76038d48..bf5210cf9 100644
--- a/DDEve/include/DDEve/ElementList.h
+++ b/DDEve/include/DDEve/ElementList.h
@@ -17,18 +17,17 @@
// ROOT include files
#include "TEveElement.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class ElementList ElementList.h DDEve/ElementList.h
- *
+ /// Local implementation with overrides of the TEveElementList
+ /*
* I do not want to override the TEveElementList context menu....
* Hence a new class is needed.
*
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class ElementList : public TEveElementList {
public:
@@ -46,10 +45,11 @@ namespace DD4hep {
ClassDef(ElementList,0);
};
- /** @class ElementListContextMenu ElementListContextMenu.h DDEve/ElementListContextMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// DDEve context menu class
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class ElementListContextMenu : public EveUserContextMenu {
protected:
diff --git a/DDEve/include/DDEve/EvePgonSetProjectedContextMenu.h b/DDEve/include/DDEve/EvePgonSetProjectedContextMenu.h
index 4b5f8cfb3..b33cb7424 100644
--- a/DDEve/include/DDEve/EvePgonSetProjectedContextMenu.h
+++ b/DDEve/include/DDEve/EvePgonSetProjectedContextMenu.h
@@ -12,15 +12,14 @@
// Framework include files
#include "DDEve/EveUserContextMenu.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class EvePgonSetProjectedContextMenu EvePgonSetProjectedContextMenu.h DDEve/EvePgonSetProjectedContextMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class EvePgonSetProjectedContextMenu EvePgonSetProjectedContextMenu.h DDEve/EvePgonSetProjectedContextMenu.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class EvePgonSetProjectedContextMenu : public EveUserContextMenu {
protected:
diff --git a/DDEve/include/DDEve/EveShapeContextMenu.h b/DDEve/include/DDEve/EveShapeContextMenu.h
index e928548a7..f9eba87f5 100644
--- a/DDEve/include/DDEve/EveShapeContextMenu.h
+++ b/DDEve/include/DDEve/EveShapeContextMenu.h
@@ -12,15 +12,14 @@
// ROOT include files
#include "DDEve/EveUserContextMenu.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class EveShapeContextMenu EveShapeContextMenu.h DDEve/EveShapeContextMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class EveShapeContextMenu EveShapeContextMenu.h DDEve/EveShapeContextMenu.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class EveShapeContextMenu : public EveUserContextMenu {
protected:
diff --git a/DDEve/include/DDEve/EveUserContextMenu.h b/DDEve/include/DDEve/EveUserContextMenu.h
index a8da3a557..ba9f40eb0 100644
--- a/DDEve/include/DDEve/EveUserContextMenu.h
+++ b/DDEve/include/DDEve/EveUserContextMenu.h
@@ -15,18 +15,17 @@
// Forward declarations
class TEveManager;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class Display;
- /** @class EveUserContextMenu EveUserContextMenu.h DDEve/EveUserContextMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class EveUserContextMenu EveUserContextMenu.h DDEve/EveUserContextMenu.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class EveUserContextMenu {
protected:
diff --git a/DDEve/include/DDEve/EventControl.h b/DDEve/include/DDEve/EventControl.h
index d7eb07770..b23480652 100644
--- a/DDEve/include/DDEve/EventControl.h
+++ b/DDEve/include/DDEve/EventControl.h
@@ -13,19 +13,21 @@
#include "DDEve/FrameControl.h"
#include "DDEve/GenericEventHandler.h"
+// Forward declarations
class TGPictureButton;
class TGLabel;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
+
+ // Forward declarations
class Display;
- /** @class EventControl EventControl.h DDEve/EventControl.h
+ /** EventControl EventControl.h DDEve/EventControl.h
*
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class EventControl : public FrameControl, public EventConsumer {
enum { NUM_DATA_LINES = 40 };
diff --git a/DDEve/include/DDEve/EventHandler.h b/DDEve/include/DDEve/EventHandler.h
index cb44f5c9b..153008360 100644
--- a/DDEve/include/DDEve/EventHandler.h
+++ b/DDEve/include/DDEve/EventHandler.h
@@ -27,11 +27,14 @@ class TH2F;
*/
namespace DD4hep {
+ // Forward declarations
class EventConsumer;
+
/// Event data actor base class for hits. Used to extract data from concrete classes.
/**
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
struct DDEveHitActor {
virtual ~DDEveHitActor() {}
diff --git a/DDEve/include/DDEve/Factories.h b/DDEve/include/DDEve/Factories.h
index b60c16811..22b622553 100644
--- a/DDEve/include/DDEve/Factories.h
+++ b/DDEve/include/DDEve/Factories.h
@@ -15,12 +15,14 @@
#include "DDEve/View.h"
#include "DDEve/Display.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
+
+ // Forward declarations
class View;
class Display;
+
+ /// Factory template for view objects
template <typename T> class ViewFactory {
public:
static View* create(Display* dis, const char* arg);
diff --git a/DDEve/include/DDEve/FrameControl.h b/DDEve/include/DDEve/FrameControl.h
index 514d96b24..fc57e61cb 100644
--- a/DDEve/include/DDEve/FrameControl.h
+++ b/DDEve/include/DDEve/FrameControl.h
@@ -20,15 +20,14 @@ class TGClient;
class TGPicture;
class TGCompositeFrame;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class FrameControl FrameControl.h DDEve/FrameControl.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class FrameControl FrameControl.h DDEve/FrameControl.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class FrameControl : public TGMainFrame {
diff --git a/DDEve/include/DDEve/GenericEventHandler.h b/DDEve/include/DDEve/GenericEventHandler.h
index 239e3cd2c..d0eb13eed 100644
--- a/DDEve/include/DDEve/GenericEventHandler.h
+++ b/DDEve/include/DDEve/GenericEventHandler.h
@@ -14,15 +14,14 @@
// Forward declarations
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
/// Event handler base class. Interface to all DDEve I/O actions
/**
- * @author M.Frank
- * @version 1.0
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class GenericEventHandler : public EventHandler {
protected:
diff --git a/DDEve/include/DDEve/HitActors.h b/DDEve/include/DDEve/HitActors.h
index c736128bb..1c87b2d68 100644
--- a/DDEve/include/DDEve/HitActors.h
+++ b/DDEve/include/DDEve/HitActors.h
@@ -19,83 +19,85 @@ class TEveElement;
class TEvePointSet;
class TEveBoxSet;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** Fill EtaPhi histograms from a hit collection
- *
- * @author M.Frank
- * @version 1.0
- */
- struct EtaPhiHistogramActor : public DDEveHitActor {
- TH2F* histogram;
- /// Standard initializing constructor
- EtaPhiHistogramActor(TH2F* h) : DDEveHitActor(), histogram(h) {}
- /// Action callback of this functor:
- virtual void operator()(const DDEveHit& hit);
- };
+ /// Fill EtaPhi histograms from a hit collection
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
+ */
+ struct EtaPhiHistogramActor : public DDEveHitActor {
+ TH2F* histogram;
+ /// Standard initializing constructor
+ EtaPhiHistogramActor(TH2F* h) : DDEveHitActor(), histogram(h) {}
+ /// Action callback of this functor:
+ virtual void operator()(const DDEveHit& hit);
+ };
- /** Fill a 3D pointset from a hit collection.
- *
- * @author M.Frank
- * @version 1.0
- */
- struct PointsetCreator : public DDEveHitActor {
- TEvePointSet* pointset;
- float deposit;
- int count;
- /// Standard initializing constructor
- PointsetCreator(const std::string& collection, size_t length);
- /// Standard initializing constructor
- PointsetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg);
- /// Standard destructor
- virtual ~PointsetCreator();
- /// Return eve element
- TEveElement* element() const;
- /// Action callback of this functor:
- virtual void operator()(const DDEveHit& hit);
- };
+ /// Fill a 3D pointset from a hit collection.
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
+ */
+ struct PointsetCreator : public DDEveHitActor {
+ TEvePointSet* pointset;
+ float deposit;
+ int count;
+ /// Standard initializing constructor
+ PointsetCreator(const std::string& collection, size_t length);
+ /// Standard initializing constructor
+ PointsetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg);
+ /// Standard destructor
+ virtual ~PointsetCreator();
+ /// Return eve element
+ TEveElement* element() const;
+ /// Action callback of this functor:
+ virtual void operator()(const DDEveHit& hit);
+ };
- /** Fill a 3D box set from a hit collection.
- *
- * @author M.Frank
- * @version 1.0
- */
- struct BoxsetCreator : public DDEveHitActor {
- TEveBoxSet* boxset;
- float emax, towerH, deposit;
- int count;
- /// Standard initializing constructor
- BoxsetCreator(const std::string& collection, size_t length);
- /// Standard initializing constructor
- BoxsetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg);
- /// Standard destructor
- virtual ~BoxsetCreator();
- /// Return eve element
- TEveElement* element() const;
- /// Action callback of this functor:
- virtual void operator()(const DDEveHit& hit);
- };
+ /// Fill a 3D box set from a hit collection.
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
+ */
+ struct BoxsetCreator : public DDEveHitActor {
+ TEveBoxSet* boxset;
+ float emax, towerH, deposit;
+ int count;
+ /// Standard initializing constructor
+ BoxsetCreator(const std::string& collection, size_t length);
+ /// Standard initializing constructor
+ BoxsetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg);
+ /// Standard destructor
+ virtual ~BoxsetCreator();
+ /// Return eve element
+ TEveElement* element() const;
+ /// Action callback of this functor:
+ virtual void operator()(const DDEveHit& hit);
+ };
- /** Fill a 3D tower set from a hit collection.
- *
- * @author M.Frank
- * @version 1.0
- */
- struct TowersetCreator : public BoxsetCreator {
- /// Standard initializing constructor
- TowersetCreator(const std::string& collection, size_t length)
- : BoxsetCreator(collection,length) {}
- /// Standard initializing constructor
- TowersetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg)
- : BoxsetCreator(collection, length, cfg) {}
- /// Standard destructor
- virtual ~TowersetCreator() {}
- /// Action callback of this functor:
- virtual void operator()(const DDEveHit& hit);
- };
+ /// Fill a 3D tower set from a hit collection.
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
+ */
+ struct TowersetCreator : public BoxsetCreator {
+ /// Standard initializing constructor
+ TowersetCreator(const std::string& collection, size_t length)
+ : BoxsetCreator(collection,length) {}
+ /// Standard initializing constructor
+ TowersetCreator(const std::string& collection, size_t length, const DisplayConfiguration::Config& cfg)
+ : BoxsetCreator(collection, length, cfg) {}
+ /// Standard destructor
+ virtual ~TowersetCreator() {}
+ /// Action callback of this functor:
+ virtual void operator()(const DDEveHit& hit);
+ };
} /* End namespace DD4hep */
diff --git a/DDEve/include/DDEve/MultiView.h b/DDEve/include/DDEve/MultiView.h
index a856fbdda..d4061e37d 100644
--- a/DDEve/include/DDEve/MultiView.h
+++ b/DDEve/include/DDEve/MultiView.h
@@ -14,17 +14,17 @@
#include "DDEve/View.h"
#include "DDEve/DisplayConfiguration.h"
+// Forward declarations
class TEveWindowPack;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class MultiView MultiView.h DDEve/MultiView.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class MultiView MultiView.h DDEve/MultiView.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class MultiView : public View {
public:
diff --git a/DDEve/include/DDEve/ParticleActors.h b/DDEve/include/DDEve/ParticleActors.h
index 371e99275..7442a78f2 100644
--- a/DDEve/include/DDEve/ParticleActors.h
+++ b/DDEve/include/DDEve/ParticleActors.h
@@ -13,6 +13,7 @@
#include "DDEve/EventHandler.h"
#include "DDEve/DisplayConfiguration.h"
+// C/C++ include files
#include <map>
// Forward declarations
@@ -21,36 +22,33 @@ class TEveCompound;
class TEveElement;
class TEveLine;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
-
- /** Fill eve particles from a MC particle collection
- *
- * @author M.Frank
- * @version 1.0
- */
- struct MCParticleCreator : public DDEveParticleActor {
- typedef std::map<std::string,TEveCompound*> Compounds;
- TEveTrackPropagator* propagator;
- TEveCompound* particles;
- Compounds types;
- int count;
- int lineWidth;
- /// Standard initializing constructor
- MCParticleCreator(TEveTrackPropagator* p, TEveCompound* ps, const DisplayConfiguration::Config* cfg);
- /// Access sub-compound by name
- void addCompound(const std::string& name, TEveLine* e);
- /// Access sub-compound by name
- void addCompoundLight(const std::string& name, TEveLine* e);
- /// Action callback of this functor:
- virtual void operator()(const DDEveParticle& particle);
- /// Close compounds
- void close();
- };
-
+ /// Fill eve particles from a MC particle collection
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
+ */
+ struct MCParticleCreator : public DDEveParticleActor {
+ typedef std::map<std::string,TEveCompound*> Compounds;
+ TEveTrackPropagator* propagator;
+ TEveCompound* particles;
+ Compounds types;
+ int count;
+ int lineWidth;
+ /// Standard initializing constructor
+ MCParticleCreator(TEveTrackPropagator* p, TEveCompound* ps, const DisplayConfiguration::Config* cfg);
+ /// Access sub-compound by name
+ void addCompound(const std::string& name, TEveLine* e);
+ /// Access sub-compound by name
+ void addCompoundLight(const std::string& name, TEveLine* e);
+ /// Action callback of this functor:
+ virtual void operator()(const DDEveParticle& particle);
+ /// Close compounds
+ void close();
+ };
} /* End namespace DD4hep */
diff --git a/DDEve/include/DDEve/PopupMenu.h b/DDEve/include/DDEve/PopupMenu.h
index 54ec40c38..1da9ad4dd 100644
--- a/DDEve/include/DDEve/PopupMenu.h
+++ b/DDEve/include/DDEve/PopupMenu.h
@@ -19,15 +19,15 @@
// Forward declarations
class TGWindow;
-/*
- * DD4hep namespace declaration
- */
+
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class PopupMenu PopupMenu.h DDEve/PopupMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class PopupMenu PopupMenu.h DDEve/PopupMenu.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class PopupMenu {
public:
diff --git a/DDEve/include/DDEve/Projection.h b/DDEve/include/DDEve/Projection.h
index 5da7c2ddd..2c0d5006f 100644
--- a/DDEve/include/DDEve/Projection.h
+++ b/DDEve/include/DDEve/Projection.h
@@ -17,15 +17,14 @@
#include <TEveProjectionManager.h>
#include <TEveProjectionAxes.h>
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class Projection Projection.h DDEve/Projection.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class Projection Projection.h DDEve/Projection.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class Projection : public View {
protected:
diff --git a/DDEve/include/DDEve/RhoPhiProjection.h b/DDEve/include/DDEve/RhoPhiProjection.h
index 49c293d1c..cd5aededd 100644
--- a/DDEve/include/DDEve/RhoPhiProjection.h
+++ b/DDEve/include/DDEve/RhoPhiProjection.h
@@ -13,15 +13,14 @@
// Framework include files
#include "DDEve/Projection.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class RhoPhiProjection RhoPhiProjection.h DDEve/RhoPhiProjection.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class RhoPhiProjection RhoPhiProjection.h DDEve/RhoPhiProjection.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class RhoPhiProjection : public Projection {
public:
diff --git a/DDEve/include/DDEve/RhoZProjection.h b/DDEve/include/DDEve/RhoZProjection.h
index 200c04028..9c209d18c 100644
--- a/DDEve/include/DDEve/RhoZProjection.h
+++ b/DDEve/include/DDEve/RhoZProjection.h
@@ -13,15 +13,14 @@
// Framework include files
#include "DDEve/Projection.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class RhoZProjection RhoZProjection.h DDEve/RhoZProjection.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class RhoZProjection RhoZProjection.h DDEve/RhoZProjection.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class RhoZProjection : public Projection {
public:
diff --git a/DDEve/include/DDEve/Utilities.h b/DDEve/include/DDEve/Utilities.h
index e9c340262..db0ba4a08 100644
--- a/DDEve/include/DDEve/Utilities.h
+++ b/DDEve/include/DDEve/Utilities.h
@@ -17,9 +17,7 @@
#include "TEveElement.h"
#include "TNamed.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
namespace Utilities {
diff --git a/DDEve/include/DDEve/View.h b/DDEve/include/DDEve/View.h
index a05bb3c97..d931871d3 100644
--- a/DDEve/include/DDEve/View.h
+++ b/DDEve/include/DDEve/View.h
@@ -26,19 +26,18 @@
class TEveManager;
class TEveElementList;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class Display;
class EventHandler;
- /** @class View View.h DDEve/View.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class View View.h DDEve/View.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class View {
public:
diff --git a/DDEve/include/DDEve/View3D.h b/DDEve/include/DDEve/View3D.h
index c157e53d6..3c06bd341 100644
--- a/DDEve/include/DDEve/View3D.h
+++ b/DDEve/include/DDEve/View3D.h
@@ -13,15 +13,14 @@
// Framework include files
#include "DDEve/View.h"
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
- /** @class View3D View3D.h DDEve/View3D.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class View3D View3D.h DDEve/View3D.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class View3D : public View {
protected:
diff --git a/DDEve/include/DDEve/ViewMenu.h b/DDEve/include/DDEve/ViewMenu.h
index 2ad1d7bff..201d3f51d 100644
--- a/DDEve/include/DDEve/ViewMenu.h
+++ b/DDEve/include/DDEve/ViewMenu.h
@@ -17,18 +17,17 @@
class TGMenuBar;
class TGMenuEntry;
-/*
- * DD4hep namespace declaration
- */
+/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class View;
- /** @class ViewMenu ViewMenu.h DDEve/ViewMenu.h
- *
- * @author M.Frank
- * @version 1.0
+ /// class ViewMenu ViewMenu.h DDEve/ViewMenu.h
+ /*
+ * \author M.Frank
+ * \version 1.0
+ * \ingroup DD4HEP_EVE
*/
class ViewMenu : public PopupMenu {
public:
--
GitLab