Doxygen: further group comments in Tools

Core/Tools/inc/AxisBin.h

@@ -18,7 +18,9 @@
 
 #include "IAxis.h"
 
-//! The bins of an axis
+//! @class AxisBin
+//! @ingroup tools
+//! @brief Binned axis.
 
 class AxisBin : public IAxis
 {

Core/Tools/inc/AxisDouble.h

@@ -22,7 +22,10 @@
 //class AxisBin;  // forward declaration needed for conversion constructor
 #include "AxisBin.h"
 
-//! The points of an axis
+
+//! @class AxisDouble
+//! @ingroup tools
+//! @brief Axis with points.
 
 class BA_CORE_API_ AxisDouble : public IAxis
 {

Core/Tools/inc/Bin.h

@@ -19,7 +19,10 @@
 #include "Numeric.h"
 #include "Types.h"
 
-//! The bounds of an one-dimensional bin
+
+//! @class Bin1D
+//! @ingroup tools_internal
+//! @brief One dimensional bin with left and right bounds.
 
 struct Bin1D
 {
@@ -28,7 +31,10 @@ struct Bin1D
     double getMidPoint() const { return (m_lower + m_upper)/2.0; }
 };
 
-//! An one-dimensional range of cvector_t's
+
+//! @class Bin1DCVector
+//! @ingroup tools_internal
+//! @brief An one-dimensional range of cvector_t's
 
 struct Bin1DCVector
 {
@@ -42,7 +48,6 @@ struct Bin1DCVector
     cvector_t m_q_upper;  //!< upper bound of the bin
 };
 
-//! equality operator for bins
 inline bool operator==(const Bin1D& left, const Bin1D& right)
 {
     if (std::abs(left.m_lower - right.m_lower) > Numeric::double_epsilon) return false;
@@ -50,7 +55,6 @@ inline bool operator==(const Bin1D& left, const Bin1D& right)
     return true;
 }
 
-//! inequality operator for bins
 inline bool operator!=(const Bin1D& left, const Bin1D& right) {
     return !(left==right);
 }

Core/Tools/inc/Convolve.h

@@ -23,8 +23,10 @@
 namespace MathFunctions
 {
 
-//! Convolution of two real vectors (in 1D or 2D) using Fast Fourier Transform.
-
+//! @class Convolve
+//! @ingroup tools
+//! @brief Convolution of two real vectors (in 1D or 2D) using Fast Fourier Transform.
+//!
 //! Usage:
 //! std::vector<double> signal, kernel, result;
 //! Convolve cv;

Core/Tools/inc/FastVector.h

@@ -19,7 +19,10 @@
 #include "Types.h"
 #include <iostream>
 
-//! A Vector of kvector_t's with optimized location/deallocation.
+
+//! @class KVectorContainer
+//! @ingroup tools_internal
+//! @brief A Vector of kvector_t's with optimized location/deallocation.
 
 class KVectorContainer {
 public:

Core/Tools/inc/FileSystem.h

@@ -23,6 +23,10 @@
 
 namespace Utils {
 
+//! @class FileSystem
+//! @ingroup tools_internal
+//! @brief Class collecting utilities to work with file system.
+
 class BA_CORE_API_ FileSystem
 {
 public:

Core/Tools/inc/IAxis.h

@@ -18,7 +18,9 @@
 
 #include "Bin.h"
 
-//! Interface for one-dimensional axes
+//! @class IAxis
+//! @ingroup tools_internal
+//! @brief Interface for one-dimensional axes
 
 class BA_CORE_API_ IAxis
 {
@@ -74,7 +76,6 @@ inline bool IAxis::equals(const IAxis& other) const
     return getName()==other.getName();
 }
 
-//! test for inequality
 inline bool operator!=(const IAxis& left, const IAxis& right) {
     return !(left == right);
 }

Core/Tools/inc/IChangeable.h

@@ -16,7 +16,9 @@
 #ifndef ICHANGEABLE_H
 #define ICHANGEABLE_H
 
-//! Inherit from this to keep track whether object has been modified.
+//! @class IChangeable
+//! @ingroup tools_internal
+//! @brief The class to keep track whether object has been modified.
 
 class IChangeable
 {

Core/Tools/inc/ICloneable.h

@@ -20,8 +20,8 @@
 
 
 //! @class ICloneable
-//! @ingroup tools
-//! @brief Standard mix-in for objects that must not be copied, except by cloning.
+//! @ingroup tools_internal
+//! @brief Interface for objects that must not be copied, except by cloning.
 //!
 //! This virtual base class disables the copy constructor and the operator=
 //! in all its child classes.

Core/Tools/inc/IFactory.h

@@ -21,7 +21,9 @@
 #include <iostream>
 #include <vector>
 
-//! Base class for all factories.
+//! @class IFactory
+//! @ingroup tools_internal
+//! @brief Base class for all factories.
 
 template<class IdentifierType, class AbstractProduct >
 class IFactory

Core/Tools/inc/INamed.h

@@ -20,7 +20,7 @@
 #include <string>
 
 //! @class INamed
-//! @ingroup tools
+//! @ingroup tools_internal
 //! @brief Interface for named objects.
 
 class BA_CORE_API_ INamed

Core/Tools/inc/IObserver.h

@@ -23,11 +23,12 @@
 
 class IObservable;
 
-//! Observer interface from Observer pattern, for 1:n object dependencies.
+//! @class IObserver
+//! @ingroup tools_internal
+//! @brief Observer interface from %Observer pattern, for 1:n object dependencies.
 
 class BA_CORE_API_ IObserver {
 public:
-//    IObserver() : m_observed_subject(0) {}
     virtual ~IObserver() {}
 
     //! method which is used by observable subject to notify change in status
@@ -35,13 +36,11 @@ public:
         throw NotImplementedException("IObserver::update() -> Not implemented");
     }
 
-//    //! Sets pointer to observed subject
-//    virtual void setObservedSubject(IObservable *subject);
-//private:
-//    IObservable *m_observed_subject;
 };
 
-//! Observable interface from Observer pattern, for 1:n object dependencies.
+//! @class IObservable
+//! @ingroup tools_internal
+//! @brief Observable interface from %Observer pattern, for 1:n object dependencies.
 
 class BA_CORE_API_ IObservable {
 public:

Core/Tools/inc/IParameterized.h

@@ -21,7 +21,7 @@
 #include "ParameterPool.h"
 
 //! @class IParameterized
-//! @ingroup tools
+//! @ingroup tools_internal
 //! @brief Manage a "local" parameter pool, and a tree of children's pools.
 
 class BA_CORE_API_ IParameterized : public INamed

Core/Tools/inc/ISingleton.h

@@ -25,6 +25,10 @@ GCC_DIAG_OFF(strict-aliasing);
 GCC_DIAG_ON(strict-aliasing);
 
 
+//! @class ISingleton
+//! @ingroup tools_internal
+//! @brief Singleton pattern.
+
 template <class T>
 class ISingleton
 {

Core/Tools/inc/IStochasticParameter.h

@@ -18,6 +18,8 @@
 
 #include "ICloneable.h"
 
+
+
 class BA_CORE_API_ IStochasticParameter : public ICloneable
 {
 public: