Merge pull request #986 from jwuttke/doxy3

Doxygen: move instrument description out of group "simulation"

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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 {

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

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
 {

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
 {

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
 {

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
 {

Core/Instrument/SimulationAreaIterator.h

@@ -20,7 +20,7 @@
 class SimulationArea;
 
 //! An iterator for SimulationArea.
-//! @ingroup simulation
+//! @ingroup detector
 
 class BA_CORE_API_ SimulationAreaIterator
 {