From dc323ad1289507791c2b27275e31446be77d7268 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Fri, 26 Jun 2020 14:49:09 +0200
Subject: [PATCH] Doxygen: new groups beam, detector
This resolves issue http://apps.jcns.fz-juelich.de/redmine/issues/2385
---
Core/Beam/Beam.h | 2 +-
Core/Beam/FootprintFactorGaussian.h | 2 +-
Core/Beam/FootprintFactorSquare.h | 2 +-
Core/Beam/IFootprintFactor.h | 2 +-
Core/Binning/IPixel.h | 2 +-
Core/Instrument/AxisNames.h | 2 +-
Core/Instrument/ConvolutionDetectorResolution.h | 2 +-
Core/Instrument/DetectionProperties.h | 2 +-
Core/Instrument/DetectorContext.h | 2 +-
Core/Instrument/DetectorFunctions.h | 2 +-
Core/Instrument/DetectorMask.h | 2 +-
Core/Instrument/IDetector.h | 2 +-
Core/Instrument/IDetector2D.h | 2 +-
Core/Instrument/IUnitConverter.h | 2 +-
Core/Instrument/Instrument.h | 2 +-
Core/Instrument/IsGISAXSDetector.h | 2 +-
Core/Instrument/RectangularDetector.h | 2 +-
Core/Instrument/RegionOfInterest.h | 2 +-
Core/Instrument/SimulationArea.h | 4 ++--
Core/Instrument/SimulationAreaIterator.h | 2 +-
Core/Instrument/SimulationResult.h | 4 ++--
Core/Instrument/SpecularDetector1D.h | 2 +-
Core/Instrument/SphericalDetector.h | 2 +-
Doc/Doxygen/defgroups.dox | 10 ++++++++--
Doc/Doxygen/userapi.dox | 12 +++++++++---
25 files changed, 42 insertions(+), 30 deletions(-)
diff --git a/Core/Beam/Beam.h b/Core/Beam/Beam.h
index 612b302664e..03a05517b0e 100644
--- a/Core/Beam/Beam.h
+++ b/Core/Beam/Beam.h
@@ -22,7 +22,7 @@
class IFootprintFactor;
//! Beam defined by wavelength, direction and intensity.
-//! @ingroup simulation
+//! @ingroup beam
class BA_CORE_API_ Beam : public INode
{
diff --git a/Core/Beam/FootprintFactorGaussian.h b/Core/Beam/FootprintFactorGaussian.h
index 2807cd1f8de..1fbd8984681 100644
--- a/Core/Beam/FootprintFactorGaussian.h
+++ b/Core/Beam/FootprintFactorGaussian.h
@@ -20,7 +20,7 @@
//! Calculates footprint coefficient for a gaussian beam
//! Beam width is interpreted as the full width on the level
//! of \f[ \exp{-1/2} \f] from the peak intensity.
-//! @ingroup simulation
+//! @ingroup beam
class BA_CORE_API_ FootprintFactorGaussian : public IFootprintFactor
{
diff --git a/Core/Beam/FootprintFactorSquare.h b/Core/Beam/FootprintFactorSquare.h
index ef3f7d85ee9..e65caa7ef34 100644
--- a/Core/Beam/FootprintFactorSquare.h
+++ b/Core/Beam/FootprintFactorSquare.h
@@ -18,7 +18,7 @@
#include "IFootprintFactor.h"
//! Calculates footprint coefficient for a square beam
-//! @ingroup simulation
+//! @ingroup beam
class BA_CORE_API_ FootprintFactorSquare : public IFootprintFactor
{
diff --git a/Core/Beam/IFootprintFactor.h b/Core/Beam/IFootprintFactor.h
index e41388350e5..62d59a94069 100644
--- a/Core/Beam/IFootprintFactor.h
+++ b/Core/Beam/IFootprintFactor.h
@@ -22,7 +22,7 @@ class MultiLayer;
class Beam;
//! Abstract base for classes that calculate the beam footprint factor
-//! @ingroup simulation
+//! @ingroup beam
class BA_CORE_API_ IFootprintFactor : public ICloneable, public INode
{
diff --git a/Core/Binning/IPixel.h b/Core/Binning/IPixel.h
index f8ac970ff52..f77ab86c401 100644
--- a/Core/Binning/IPixel.h
+++ b/Core/Binning/IPixel.h
@@ -19,7 +19,7 @@
#include "WinDllMacros.h"
//! Interface for a function that maps [0,1]x[0,1] to the kvectors in a pixel.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ IPixel
{
diff --git a/Core/Instrument/AxisNames.h b/Core/Instrument/AxisNames.h
index 119f67f43c9..c267681174b 100644
--- a/Core/Instrument/AxisNames.h
+++ b/Core/Instrument/AxisNames.h
@@ -20,7 +20,7 @@
//! Contains functions to create maps that give the right axis names for different
//! detector types and units
-//! @ingroup simulation
+//! @ingroup detector
namespace AxisNames
{
diff --git a/Core/Instrument/ConvolutionDetectorResolution.h b/Core/Instrument/ConvolutionDetectorResolution.h
index d307ffa4765..1f2a0f4b356 100644
--- a/Core/Instrument/ConvolutionDetectorResolution.h
+++ b/Core/Instrument/ConvolutionDetectorResolution.h
@@ -19,7 +19,7 @@
#include "IResolutionFunction2D.h"
//! Convolutes the intensity in 1 or 2 dimensions with a resolution function.
-//! @ingroup simulation
+//! @ingroup detector
//! Limitation: this class assumes that the data points are evenly distributed on each axis
diff --git a/Core/Instrument/DetectionProperties.h b/Core/Instrument/DetectionProperties.h
index 48639925caa..6c1924b1dad 100644
--- a/Core/Instrument/DetectionProperties.h
+++ b/Core/Instrument/DetectionProperties.h
@@ -21,7 +21,7 @@
#include "WinDllMacros.h"
//! Detector properties (efficiency, transmission).
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ DetectionProperties : public INode
{
diff --git a/Core/Instrument/DetectorContext.h b/Core/Instrument/DetectorContext.h
index bd68c8943c7..eb1b6763007 100644
--- a/Core/Instrument/DetectorContext.h
+++ b/Core/Instrument/DetectorContext.h
@@ -24,7 +24,7 @@
class IDetector2D;
//! Holds precalculated information for faster SimulationElement generation.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ DetectorContext
{
diff --git a/Core/Instrument/DetectorFunctions.h b/Core/Instrument/DetectorFunctions.h
index e3fc15556a5..b92aa2095a6 100644
--- a/Core/Instrument/DetectorFunctions.h
+++ b/Core/Instrument/DetectorFunctions.h
@@ -26,7 +26,7 @@ class IDetector;
class SimulationAreaIterator;
//! Contains set of detector-related convenience functions.
-//! @ingroup simulation
+//! @ingroup detector
namespace DetectorFunctions
{
diff --git a/Core/Instrument/DetectorMask.h b/Core/Instrument/DetectorMask.h
index 2bfd0827dd9..9eba18a3b05 100644
--- a/Core/Instrument/DetectorMask.h
+++ b/Core/Instrument/DetectorMask.h
@@ -23,7 +23,7 @@ template <class T> class OutputData;
class Histogram2D;
//! Collection of detector masks.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ DetectorMask
{
diff --git a/Core/Instrument/IDetector.h b/Core/Instrument/IDetector.h
index 621e30cd42d..30d509c201d 100644
--- a/Core/Instrument/IDetector.h
+++ b/Core/Instrument/IDetector.h
@@ -32,7 +32,7 @@ class SimulationElement;
class RegionOfInterest;
//! Abstract detector interface.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ IDetector : public ICloneable, public INode
{
diff --git a/Core/Instrument/IDetector2D.h b/Core/Instrument/IDetector2D.h
index 4e8c51d0855..0cae2b6d1aa 100644
--- a/Core/Instrument/IDetector2D.h
+++ b/Core/Instrument/IDetector2D.h
@@ -25,7 +25,7 @@ class IShape2D;
class DetectorContext;
//! Abstract 2D detector interface.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ IDetector2D : public IDetector
{
diff --git a/Core/Instrument/IUnitConverter.h b/Core/Instrument/IUnitConverter.h
index 2ec6a994b20..8ec46344ec6 100644
--- a/Core/Instrument/IUnitConverter.h
+++ b/Core/Instrument/IUnitConverter.h
@@ -26,7 +26,7 @@ template <class T> class OutputData;
//! Wrapper for detector axes units, required for a better representation of
//! detector axes units in python
-//! @ingroup simulation
+//! @ingroup detector
// workaround for SWIG (instead of just writing enum class AxesUnits...)
struct BA_CORE_API_ AxesUnitsWrap {
diff --git a/Core/Instrument/Instrument.h b/Core/Instrument/Instrument.h
index fae13981395..30d0e88d905 100644
--- a/Core/Instrument/Instrument.h
+++ b/Core/Instrument/Instrument.h
@@ -28,7 +28,7 @@ class IDetector2D;
class IResolutionFunction2D;
class SimulationElement;
-//! Assembles beam, detector and their relative positions wrt the sample.
+//! Assembles beam, detector and their relative positions with respect to the sample.
//! @ingroup simulation_internal
class BA_CORE_API_ Instrument : public INode
diff --git a/Core/Instrument/IsGISAXSDetector.h b/Core/Instrument/IsGISAXSDetector.h
index 84bf08cb996..ace9a82ea35 100644
--- a/Core/Instrument/IsGISAXSDetector.h
+++ b/Core/Instrument/IsGISAXSDetector.h
@@ -18,7 +18,7 @@
#include "SphericalDetector.h"
//! A spherical detector used for validation with IsGISAXS results.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ IsGISAXSDetector : public SphericalDetector
{
diff --git a/Core/Instrument/RectangularDetector.h b/Core/Instrument/RectangularDetector.h
index c23ff1e8880..5a788e0b298 100644
--- a/Core/Instrument/RectangularDetector.h
+++ b/Core/Instrument/RectangularDetector.h
@@ -21,7 +21,7 @@
class RectangularPixel;
//! A flat rectangular detector with axes and resolution function.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ RectangularDetector : public IDetector2D
{
diff --git a/Core/Instrument/RegionOfInterest.h b/Core/Instrument/RegionOfInterest.h
index fbbdb491d09..096d6c62f0a 100644
--- a/Core/Instrument/RegionOfInterest.h
+++ b/Core/Instrument/RegionOfInterest.h
@@ -25,7 +25,7 @@ class IAxis;
template <class T> class OutputData;
//! Defines rectangular area for the detector which will be simulated/fitted.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ RegionOfInterest : public ICloneable
{
diff --git a/Core/Instrument/SimulationArea.h b/Core/Instrument/SimulationArea.h
index 83290bb526a..161e3d9b5c5 100644
--- a/Core/Instrument/SimulationArea.h
+++ b/Core/Instrument/SimulationArea.h
@@ -22,7 +22,7 @@ class IDetector;
//! Holds iteration logic over active detector channels in the presence of masked areas
//! and RegionOfInterest defined.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SimulationArea
{
@@ -57,7 +57,7 @@ inline size_t SimulationArea::totalSize() const
//! Holds iteration logic over active detector channels in the presence of ROI. On the contrary
//! to SimulationArea class, iterates also over masked areas.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SimulationRoiArea : public SimulationArea
{
diff --git a/Core/Instrument/SimulationAreaIterator.h b/Core/Instrument/SimulationAreaIterator.h
index 0cce544e90b..7ccc9a34f82 100644
--- a/Core/Instrument/SimulationAreaIterator.h
+++ b/Core/Instrument/SimulationAreaIterator.h
@@ -20,7 +20,7 @@
class SimulationArea;
//! An iterator for SimulationArea.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SimulationAreaIterator
{
diff --git a/Core/Instrument/SimulationResult.h b/Core/Instrument/SimulationResult.h
index 8701d1a7680..9916cc1b26a 100644
--- a/Core/Instrument/SimulationResult.h
+++ b/Core/Instrument/SimulationResult.h
@@ -27,7 +27,7 @@ class IAxis;
template <class T> class OutputData;
//! Information about an axis in specific units. Can be used for plotting.
-//! @ingroup simulation
+//! @ingroup detector
struct AxisInfo {
std::string m_name;
@@ -36,7 +36,7 @@ struct AxisInfo {
};
//! Wrapper around OutputData<double> that also provides unit conversions.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SimulationResult
{
diff --git a/Core/Instrument/SpecularDetector1D.h b/Core/Instrument/SpecularDetector1D.h
index c5a355b6fe5..517d71b805c 100644
--- a/Core/Instrument/SpecularDetector1D.h
+++ b/Core/Instrument/SpecularDetector1D.h
@@ -20,7 +20,7 @@
class SpecularSimulationElement;
//! 1D detector for specular simulations. Use of this detector is deprecated.
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SpecularDetector1D : public IDetector
{
diff --git a/Core/Instrument/SphericalDetector.h b/Core/Instrument/SphericalDetector.h
index f74b2622ef3..60c489ea52d 100644
--- a/Core/Instrument/SphericalDetector.h
+++ b/Core/Instrument/SphericalDetector.h
@@ -20,7 +20,7 @@
//! A spherical detector with axes and resolution function.
//! SphericalDetector
-//! @ingroup simulation
+//! @ingroup detector
class BA_CORE_API_ SphericalDetector : public IDetector2D
{
diff --git a/Doc/Doxygen/defgroups.dox b/Doc/Doxygen/defgroups.dox
index 37c59035309..8072c38dd10 100644
--- a/Doc/Doxygen/defgroups.dox
+++ b/Doc/Doxygen/defgroups.dox
@@ -3,6 +3,12 @@
\defgroup simulation Simulation description
@brief Classes to describe beam, detector and run the simulation.
+\defgroup beam
+@brief Classes to describe the incoming beam and its footprint in the sample plane
+
+\defgroup detector
+@brief Classes to describe a detector
+
\defgroup mask Detector masks
@brief Classes to construct a two-dimensional mask.
@@ -37,8 +43,8 @@
\defgroup paramDistribution Parameter distributions
-\defgroup simulation_internal Simulation internals
-@brief Simulation internal classes.
+\defgroup simulation_internal Simulation and instrument internals
+@brief Internal classes concerned with simulations and instrument
\defgroup samples_internal Sample internals
@brief Sample internal classes.
diff --git a/Doc/Doxygen/userapi.dox b/Doc/Doxygen/userapi.dox
index 7e537366427..0f0009f563a 100644
--- a/Doc/Doxygen/userapi.dox
+++ b/Doc/Doxygen/userapi.dox
@@ -5,9 +5,15 @@ Here is a list of classes grouped in several categories to create the sample, de
<ul>
<li> \ref simulation "Simulation" <br>
-List of classes to describe beam, detector and run the simulation
+List of classes to run simulations
<ul>
- <li> \ref mask "Detector masks"
+ <li> \ref beam "Beam" <br>
+ List of classes to describe the beam, and its footprint in the sample plane
+ <li> \ref detector "Detector" <br>
+ List of classes to describe detectors
+ <ul>
+ <li> \ref mask "Detector masks"
+ </ul>
</ul>
<li> \ref samples "Samples" <br>
List of classes to describe scattering sample
@@ -38,7 +44,7 @@ Fitting routines
Here is a list of additional classes from internal API.
<ul>
-<li> \ref simulation_internal "Simulation internals" <br>
+<li> \ref simulation_internal "Simulation and instrument internals" <br>
<li> \ref samples_internal "Samples internals" <br>
<li> \ref materials_internal "Materials internals" <br>
<li> \ref formfactors_internal "Form factors internals" <br>
--
GitLab