Skip to content
Snippets Groups Projects
Commit 5e8e5724 authored by Wuttke, Joachim's avatar Wuttke, Joachim Committed by Wuttke, Joachim
Browse files

improve class comments

parent 6bd82fbf
No related branches found
No related tags found
No related merge requests found
...@@ -21,8 +21,10 @@ ...@@ -21,8 +21,10 @@
#include <functional> #include <functional>
#include <string> #include <string>
//! Pure virtual base class for parameter wrapper classes RealParameter, ObjectParameter. //! Pure virtual base class for parameter wrapper classes RealParameter, ComponentParameter.
//! It's templated on the data type of the wrapped parameter. //! Holds a pointer to the wrapped parameter, a name, and a callback function to be called
//! when the parameter is changed.
//! This class is templated on the data type of the wrapped parameter.
//! @class IParameter //! @class IParameter
//! @ingroup tools_internal //! @ingroup tools_internal
......
...@@ -24,8 +24,9 @@ ...@@ -24,8 +24,9 @@
class ParameterPool; class ParameterPool;
//! Wrapper to real parameter for remote access to its value and callback abilities //! Wraps a parameter of type double.
//! @class RealParameter //! In addition to name and on-change callback held by the parent class IParameter,
//! this class holds Limits, Attributes (currently only fixed or not), and a Unit.
//! @ingroup tools_internal //! @ingroup tools_internal
class BA_CORE_API_ RealParameter : public IParameter<double> { class BA_CORE_API_ RealParameter : public IParameter<double> {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment