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

corr class comments

parent 957af176
No related branches found
No related tags found
No related merge requests found
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
class IFootprintFactor; class IFootprintFactor;
//! Beam defined by wavelength, direction and intensity. //! An incident neutron or x-ray beam.
//! @ingroup beam //! @ingroup beam
class Beam : public INode { class Beam : public INode {
......
...@@ -17,9 +17,9 @@ ...@@ -17,9 +17,9 @@
#include "Device/Beam/IFootprintFactor.h" #include "Device/Beam/IFootprintFactor.h"
//! Calculates footprint coefficient for a gaussian beam //! Gaussian beam footprint.
//! Beam width is interpreted as the full width on the level //!
//! of \f[ \exp{-1/2} \f] from the peak intensity. //! Beam width is the full width at half maximum.
//! @ingroup beam //! @ingroup beam
class FootprintGauss : public IFootprintFactor { class FootprintGauss : public IFootprintFactor {
......
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
#include "Device/Beam/IFootprintFactor.h" #include "Device/Beam/IFootprintFactor.h"
//! Calculates footprint coefficient for a square beam //! Rectangular beam footprint.
//! @ingroup beam //! @ingroup beam
class FootprintSquare : public IFootprintFactor { class FootprintSquare : public IFootprintFactor {
......
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
#include "Device/Mask/IShape2D.h" #include "Device/Mask/IShape2D.h"
//! Ellipse shape. //! An ellipse, for use in detector masks.
//! @ingroup tools //! @ingroup tools
class Ellipse : public IShape2D { class Ellipse : public IShape2D {
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
#include "Device/Mask/IShape2D.h" #include "Device/Mask/IShape2D.h"
//! The infinite plane is used for masking everything once and forever. //! The infinite plane is used for masking the entire detector.
//! @ingroup tools //! @ingroup tools
class InfinitePlane : public IShape2D { class InfinitePlane : public IShape2D {
......
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
#include "Device/Mask/IShape2D.h" #include "Device/Mask/IShape2D.h"
//! A line segment. //! A line segment, for use in detector masks.
//! @ingroup mask //! @ingroup mask
class Line : public IShape2D { class Line : public IShape2D {
......
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
class PolygonPrivate; class PolygonPrivate;
//! A polygon in 2D space. //! A polygon, for use in detector masks.
//! @ingroup mask //! @ingroup mask
//! Polygon defined by two arrays with x and y coordinates of points. //! Polygon defined by two arrays with x and y coordinates of points.
......
...@@ -17,7 +17,9 @@ ...@@ -17,7 +17,9 @@
#include "Device/Mask/IShape2D.h" #include "Device/Mask/IShape2D.h"
//! The rectangle shape having its axis aligned to the (non-rotated) coordinate system. //! A rectangle, for use in detector masks.
//!
//! Edges are along the coordinate axes.
//! @ingroup mask //! @ingroup mask
class Rectangle : public IShape2D { class Rectangle : public IShape2D {
......
...@@ -19,7 +19,7 @@ ...@@ -19,7 +19,7 @@
#include <ostream> #include <ostream>
//! Attributes for a fit parameter. Currently, the only attribute is fixed/free. //! %Attributes for a fit parameter. Currently, the only attribute is fixed/free.
//! @ingroup fitting //! @ingroup fitting
class Attributes { class Attributes {
......
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