Skip to content
Snippets Groups Projects
Commit 6dcf72fd authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

[i440] Doxygen: update links, rm User API tab, rm @ingroup markup (Closes #440)

Merging branch 'i440'  into 'main'.

See merge request !1315
parents 8a35b896 b6bf453d
No related branches found
No related tags found
1 merge request!1315Doxygen: update links, rm User API tab, rm @ingroup markup
Pipeline #87251 passed
Showing
with 1 addition and 20 deletions
...@@ -10,7 +10,7 @@ Former members of the development team: ...@@ -10,7 +10,7 @@ Former members of the development team:
* Céline Durniak (2013-2015) * Céline Durniak (2013-2015)
* Jonathan Fisher (2016-2017) * Jonathan Fisher (2016-2017)
* Marina Ganeva (2013-2019) * Marina Ganeva (2013-2019)
* Tobias Knopf (2021) * Tobias Knopff (2021)
* Gennady Pospelov (2012-2021) * Gennady Pospelov (2012-2021)
* Matthias Puchner (2020-2022) * Matthias Puchner (2020-2022)
* Alexander Schober (2020) * Alexander Schober (2020)
......
...@@ -18,7 +18,6 @@ ...@@ -18,7 +18,6 @@
#include "Base/Axis/VariableBinAxis.h" #include "Base/Axis/VariableBinAxis.h"
//! Axis with fixed bin size in sin(angle) space. //! Axis with fixed bin size in sin(angle) space.
//! @ingroup tools
class ConstKBinAxis : public VariableBinAxis { class ConstKBinAxis : public VariableBinAxis {
public: public:
......
...@@ -19,7 +19,6 @@ ...@@ -19,7 +19,6 @@
//! Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs. //! Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs.
//! The main feature of the axis is that it produces zero bin sizes. //! The main feature of the axis is that it produces zero bin sizes.
//! @ingroup tools
class CustomBinAxis : public VariableBinAxis { class CustomBinAxis : public VariableBinAxis {
public: public:
......
...@@ -18,7 +18,6 @@ ...@@ -18,7 +18,6 @@
#include "Base/Axis/IAxis.h" #include "Base/Axis/IAxis.h"
//! Axis with fixed bin size. //! Axis with fixed bin size.
//! @ingroup tools
class FixedBinAxis : public IAxis { class FixedBinAxis : public IAxis {
public: public:
......
...@@ -27,7 +27,6 @@ ...@@ -27,7 +27,6 @@
//! values produced by Bin1D::center. //! values produced by Bin1D::center.
//! On-axis values are bounded by minimum/maximum //! On-axis values are bounded by minimum/maximum
//! values passed to the constructor. //! values passed to the constructor.
//! @ingroup tools
class PointwiseAxis : public IAxis { class PointwiseAxis : public IAxis {
public: public:
......
...@@ -18,7 +18,6 @@ ...@@ -18,7 +18,6 @@
#include "Base/Axis/IAxis.h" #include "Base/Axis/IAxis.h"
//! Axis with variable bin size. //! Axis with variable bin size.
//! @ingroup tools
class VariableBinAxis : public IAxis { class VariableBinAxis : public IAxis {
public: public:
......
...@@ -22,7 +22,6 @@ ...@@ -22,7 +22,6 @@
//! Interface for a function that maps [0,1]x[0,1] to the kvectors in a pixel. //! Interface for a function that maps [0,1]x[0,1] to the kvectors in a pixel.
//! Abstract base class for SphericalPixel and RectangularPixel. //! Abstract base class for SphericalPixel and RectangularPixel.
//! @ingroup detector
class IPixel { class IPixel {
public: public:
......
...@@ -22,7 +22,6 @@ ...@@ -22,7 +22,6 @@
//! An interval. Limits are of type double, and may be infinite. //! An interval. Limits are of type double, and may be infinite.
//! Used for the z-coordinate, especially when slicing form factors. //! Used for the z-coordinate, especially when slicing form factors.
//! //!
//! @ingroup intern
class Span { class Span {
public: public:
......
...@@ -16,7 +16,6 @@ ...@@ -16,7 +16,6 @@
#define BORNAGAIN_BASE_UTIL_THREADINFO_H #define BORNAGAIN_BASE_UTIL_THREADINFO_H
//! Information to run simulation with dedicated number of threads. //! Information to run simulation with dedicated number of threads.
//! @ingroup simulation
struct ThreadInfo { struct ThreadInfo {
unsigned n_threads{0}; unsigned n_threads{0};
......
...@@ -22,7 +22,6 @@ class IFootprintFactor; ...@@ -22,7 +22,6 @@ class IFootprintFactor;
class SpinMatrix; class SpinMatrix;
//! An incident neutron or x-ray beam. //! An incident neutron or x-ray beam.
//! @ingroup beam
class Beam : public INode { class Beam : public INode {
public: public:
......
...@@ -20,7 +20,6 @@ ...@@ -20,7 +20,6 @@
//! Gaussian beam footprint. //! Gaussian beam footprint.
//! //!
//! Beam width is the full width at half maximum. //! Beam width is the full width at half maximum.
//! @ingroup beam
class FootprintGauss : public IFootprintFactor { class FootprintGauss : public IFootprintFactor {
public: public:
......
...@@ -18,7 +18,6 @@ ...@@ -18,7 +18,6 @@
#include "Device/Beam/IFootprintFactor.h" #include "Device/Beam/IFootprintFactor.h"
//! Rectangular beam footprint. //! Rectangular beam footprint.
//! @ingroup beam
class FootprintSquare : public IFootprintFactor { class FootprintSquare : public IFootprintFactor {
public: public:
......
...@@ -22,7 +22,6 @@ class MultiLayer; ...@@ -22,7 +22,6 @@ class MultiLayer;
class Beam; class Beam;
//! Abstract base for classes that calculate the beam footprint factor //! Abstract base for classes that calculate the beam footprint factor
//! @ingroup beam
class IFootprintFactor : public ICloneable, public INode { class IFootprintFactor : public ICloneable, public INode {
public: public:
......
...@@ -15,7 +15,6 @@ ...@@ -15,7 +15,6 @@
#ifndef BORNAGAIN_DEVICE_COORD_TAGS_H #ifndef BORNAGAIN_DEVICE_COORD_TAGS_H
#define BORNAGAIN_DEVICE_COORD_TAGS_H #define BORNAGAIN_DEVICE_COORD_TAGS_H
//! @ingroup detector
enum class Coords { UNDEFINED, NBINS, RADIANS, DEGREES, MM, QSPACE, RQ4 }; enum class Coords { UNDEFINED, NBINS, RADIANS, DEGREES, MM, QSPACE, RQ4 };
......
...@@ -25,7 +25,6 @@ class IAxis; ...@@ -25,7 +25,6 @@ class IAxis;
class Frame; class Frame;
//! Stores radiation power per bin. //! Stores radiation power per bin.
//! @ingroup tools
class Datafield { class Datafield {
public: public:
......
...@@ -48,7 +48,6 @@ class SimulationAreaIterator; ...@@ -48,7 +48,6 @@ class SimulationAreaIterator;
//! To access the explicitly set ROI, use the methods which have the explicit in its //! To access the explicitly set ROI, use the methods which have the explicit in its
//! name, like sizeOfExplicitRegionOfInterest(). //! name, like sizeOfExplicitRegionOfInterest().
//! //!
//! @ingroup detector
class IDetector : public ICloneable, public INode { class IDetector : public ICloneable, public INode {
public: public:
......
...@@ -21,7 +21,6 @@ class IPixel; ...@@ -21,7 +21,6 @@ class IPixel;
class RectangularPixel; class RectangularPixel;
//! A flat rectangular detector with axes and resolution function. //! A flat rectangular detector with axes and resolution function.
//! @ingroup detector
class RectangularDetector : public IDetector { class RectangularDetector : public IDetector {
public: public:
......
...@@ -23,7 +23,6 @@ ...@@ -23,7 +23,6 @@
class IDetector; class IDetector;
//! An iterator for SimulationArea. //! An iterator for SimulationArea.
//! @ingroup detector
class SimulationAreaIterator { class SimulationAreaIterator {
public: public:
......
...@@ -20,7 +20,6 @@ ...@@ -20,7 +20,6 @@
class IPixel; class IPixel;
//! A detector with coordinate axes along angles phi and alpha. //! A detector with coordinate axes along angles phi and alpha.
//! @ingroup detector
class SphericalDetector : public IDetector { class SphericalDetector : public IDetector {
public: public:
......
...@@ -26,7 +26,6 @@ class IAxis; ...@@ -26,7 +26,6 @@ class IAxis;
class ICoordSystem; class ICoordSystem;
//! Wrapper around Datafield that also provides unit conversions. //! Wrapper around Datafield that also provides unit conversions.
//! @ingroup detector
class SimulationResult { class SimulationResult {
public: public:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment