diff --git a/Device/Beam/Beam.h b/Device/Beam/Beam.h index c07bdb1a75985c9bf16496511f08c655d40a0718..2911d5d9ca887e2ea6c1db57935682925a70c336 100644 --- a/Device/Beam/Beam.h +++ b/Device/Beam/Beam.h @@ -21,7 +21,7 @@ class IFootprintFactor; -//! Beam defined by wavelength, direction and intensity. +//! An incident neutron or x-ray beam. //! @ingroup beam class Beam : public INode { diff --git a/Device/Beam/FootprintGauss.h b/Device/Beam/FootprintGauss.h index 1a945c109f447556c680b1dc1c3159d5534e56eb..cb557cb2d0c928a0ae3437c377e7ac2a6c8b0afd 100644 --- a/Device/Beam/FootprintGauss.h +++ b/Device/Beam/FootprintGauss.h @@ -17,9 +17,9 @@ #include "Device/Beam/IFootprintFactor.h" -//! 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. +//! Gaussian beam footprint. +//! +//! Beam width is the full width at half maximum. //! @ingroup beam class FootprintGauss : public IFootprintFactor { diff --git a/Device/Beam/FootprintSquare.h b/Device/Beam/FootprintSquare.h index 84922298f776a40f0e0cf2007b6599c256a126ae..d466decfd5e335e1f032f89d5cbbc16984796fa8 100644 --- a/Device/Beam/FootprintSquare.h +++ b/Device/Beam/FootprintSquare.h @@ -17,7 +17,7 @@ #include "Device/Beam/IFootprintFactor.h" -//! Calculates footprint coefficient for a square beam +//! Rectangular beam footprint. //! @ingroup beam class FootprintSquare : public IFootprintFactor { diff --git a/Device/Mask/Ellipse.h b/Device/Mask/Ellipse.h index 9ad77609f644d80e5910ac9d763d020ff589244d..d820582c3a20f2144e2875649a4ac144ad15639d 100644 --- a/Device/Mask/Ellipse.h +++ b/Device/Mask/Ellipse.h @@ -17,7 +17,7 @@ #include "Device/Mask/IShape2D.h" -//! Ellipse shape. +//! An ellipse, for use in detector masks. //! @ingroup tools class Ellipse : public IShape2D { diff --git a/Device/Mask/InfinitePlane.h b/Device/Mask/InfinitePlane.h index c57101022c23e0e5ce22f3f1aad0082746b3af50..470c2005b6199295293a7bb7b018be1d76c089bd 100644 --- a/Device/Mask/InfinitePlane.h +++ b/Device/Mask/InfinitePlane.h @@ -22,7 +22,7 @@ #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 class InfinitePlane : public IShape2D { diff --git a/Device/Mask/Line.h b/Device/Mask/Line.h index 4e65a401c026976d9b0552c9adc96cd0d4017317..d2dd1cd3bdb3ff6cf9094710fd8e780c9b9bf996 100644 --- a/Device/Mask/Line.h +++ b/Device/Mask/Line.h @@ -17,7 +17,7 @@ #include "Device/Mask/IShape2D.h" -//! A line segment. +//! A line segment, for use in detector masks. //! @ingroup mask class Line : public IShape2D { diff --git a/Device/Mask/Polygon.h b/Device/Mask/Polygon.h index ac6fff04d438092769858f43535ec2ee9eee5f0b..cc22fc92f09c3e5ff0d0d076150835747272bc9c 100644 --- a/Device/Mask/Polygon.h +++ b/Device/Mask/Polygon.h @@ -20,7 +20,7 @@ class PolygonPrivate; -//! A polygon in 2D space. +//! A polygon, for use in detector masks. //! @ingroup mask //! Polygon defined by two arrays with x and y coordinates of points. diff --git a/Device/Mask/Rectangle.h b/Device/Mask/Rectangle.h index db7d344e698b976f8fdbbece4c3e79ad68063a4c..29a9aa33cf814bb8f8da8dff10964247aa8d3d9b 100644 --- a/Device/Mask/Rectangle.h +++ b/Device/Mask/Rectangle.h @@ -17,7 +17,9 @@ #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 class Rectangle : public IShape2D { diff --git a/Fit/Param/Attributes.h b/Fit/Param/Attributes.h index 580815178b6b3965573a096b69bd055d091b8a19..539a56e1b4b26ece3a18a499098654bd40c98a63 100644 --- a/Fit/Param/Attributes.h +++ b/Fit/Param/Attributes.h @@ -19,7 +19,7 @@ #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 class Attributes {