diff --git a/App/AppOptions.h b/App/AppOptions.h index 110eff509b334d350ba5df1ab9f0bdd0600be0a0..9e77c8496927156c1ee2e20e5740c64e1baec545 100644 --- a/App/AppOptions.h +++ b/App/AppOptions.h @@ -26,8 +26,7 @@ class QString; namespace bpo = boost::program_options; -//! @class ApplicationOptions -//! @brief Handles command line and config file program options +//! Handles command line and config file program options class ApplicationOptions { public: diff --git a/GUI/Support/Util/MessageService.h b/GUI/Support/Util/MessageService.h index 0b92d624743ba2dd441204f863640213887b0818..187a44efac2f440a870be3b215317eb93b7a9b79 100644 --- a/GUI/Support/Util/MessageService.h +++ b/GUI/Support/Util/MessageService.h @@ -21,8 +21,7 @@ class QObject; -//! @class MessageService -//! @brief The service to collect messages from different senders. +//! The service to collect messages from different senders. class MessageService { public: diff --git a/GUI/View/Project/ProjectLoadProblemDialog.h b/GUI/View/Project/ProjectLoadProblemDialog.h index 3bb5635088e9d823b803d79e0b40c4f16919e504..65a3be80c621bdf752688f9ee315924e3bddf907 100644 --- a/GUI/View/Project/ProjectLoadProblemDialog.h +++ b/GUI/View/Project/ProjectLoadProblemDialog.h @@ -18,8 +18,7 @@ #include <QDialog> #include <QString> -//! @class ProjectLoadProblemDialog -//! @brief The dialog to inform user about encountered problems during the loading of old project +//! The dialog to inform user about encountered problems during the loading of old project class ProjectLoadProblemDialog : public QDialog { Q_OBJECT diff --git a/GUI/View/Projection/ProjectionsPlot.cpp b/GUI/View/Projection/ProjectionsPlot.cpp index 1d4d6b542429bad9decb5398abd6b423096af381..76ffdbdd3daf3eb1fd747ea8591cfbc7f2a469c6 100644 --- a/GUI/View/Projection/ProjectionsPlot.cpp +++ b/GUI/View/Projection/ProjectionsPlot.cpp @@ -3,7 +3,7 @@ // BornAgain: simulate and fit reflection and scattering // //! @file GUI/View/Projection/ProjectionsPlot.cpp -//! @brief Defines class ProjectionCanvas +//! @brief Implements class ProjectionsPlot //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) diff --git a/GUI/View/PropertyEditor/CustomEditors.cpp b/GUI/View/PropertyEditor/CustomEditors.cpp index 695e1b9615164745658bfd9692d35c8107d2d95a..e4170930aae8b4f173521480fb530136b6585c20 100644 --- a/GUI/View/PropertyEditor/CustomEditors.cpp +++ b/GUI/View/PropertyEditor/CustomEditors.cpp @@ -3,7 +3,7 @@ // BornAgain: simulate and fit reflection and scattering // //! @file GUI/View/PropertyEditor/CustomEditors.cpp -//! @brief Implements CustomEditors classes +//! @brief Implements classes CustomEditor, ComboPropertyEditor, ScientificSpinBoxEditor //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -34,6 +34,10 @@ double singleStep(int decimals) } // namespace +// ************************************************************************************************ +// class CustomEditor +// ************************************************************************************************ + //! Sets the data from the model to editor. void CustomEditor::setData(const QVariant& data) @@ -54,7 +58,9 @@ void CustomEditor::setDataIntern(const QVariant& data) dataChanged(m_data); } -// --- ComboPropertyEditor --- +// ************************************************************************************************ +// class ComboPropertyEditor +// ************************************************************************************************ ComboPropertyEditor::ComboPropertyEditor(QWidget* parent) : CustomEditor(parent) @@ -132,7 +138,9 @@ void ComboPropertyEditor::setConnected(bool isConnected) this, &ComboPropertyEditor::onIndexChanged); } -// --- ScientificSpinBoxEditor --- +// ************************************************************************************************ +// class ScientificSpinBoxEditor +// ************************************************************************************************ ScientificSpinBoxEditor::ScientificSpinBoxEditor(QWidget* parent) : CustomEditor(parent) diff --git a/GUI/View/PropertyEditor/CustomEditors.h b/GUI/View/PropertyEditor/CustomEditors.h index 58c657a8eafd5451840f3ddf98b4d6cee918c9d2..2ce7d2f3b137d18c1ee692fd5a956ebd2377a7f2 100644 --- a/GUI/View/PropertyEditor/CustomEditors.h +++ b/GUI/View/PropertyEditor/CustomEditors.h @@ -3,7 +3,7 @@ // BornAgain: simulate and fit reflection and scattering // //! @file GUI/View/PropertyEditor/CustomEditors.h -//! @brief Defines CustomEditors classes +//! @brief Defines classes CustomEditor, ComboPropertyEditor, ScientificSpinBoxEditor //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) diff --git a/Sample/ComponentBuilder/FormFactorComponents.h b/Sample/ComponentBuilder/FormFactorComponents.h index 5ab10738f7b99af0cf5a605601816796209bbbc1..cac306cb8b94fd4dfc9100663674ef71a4251255 100644 --- a/Sample/ComponentBuilder/FormFactorComponents.h +++ b/Sample/ComponentBuilder/FormFactorComponents.h @@ -21,8 +21,7 @@ #include "Sample/ComponentBuilder/IRegistry.h" #include "Sample/HardParticle/HardParticles.h" -//! @class FormFactorComponents -//! @brief Predefined form factors for functional tests. +//! Predefined form factors for functional tests. class FormFactorComponents : public IRegistry<IFormFactor> { public: diff --git a/Sample/ComponentBuilder/IRegistry.h b/Sample/ComponentBuilder/IRegistry.h index 430c2fc5da4e3985320bc91a5832c45b1fabd031..8b1dc94de2bcd1e3847f8865dabe71707ce7b64a 100644 --- a/Sample/ComponentBuilder/IRegistry.h +++ b/Sample/ComponentBuilder/IRegistry.h @@ -24,13 +24,12 @@ #include <string> #include <vector> -//! @class IRegistry -//! @brief Templated object registry. +//! Templated object registry. -template <class ValueType> +template <class T> class IRegistry { public: - const ValueType* getItem(const std::string& key) const + const T* getItem(const std::string& key) const { auto it = m_data.find(key); ASSERT(it != m_data.end()); @@ -48,14 +47,14 @@ public: size_t size() const { return m_data.size(); } protected: - void add(const std::string& key, ValueType* item) + void add(const std::string& key, T* item) { ASSERT(m_data.find(key) == m_data.end()); - m_data[key] = std::unique_ptr<ValueType>(item); + m_data[key] = std::unique_ptr<T>(item); } private: - std::map<std::string, std::unique_ptr<ValueType>> m_data; + std::map<std::string, std::unique_ptr<T>> m_data; }; #endif // BORNAGAIN_SAMPLE_COMPONENTBUILDER_IREGISTRY_H diff --git a/Sample/ComponentBuilder/Profile2DComponents.h b/Sample/ComponentBuilder/Profile2DComponents.h index eb0dfc04651a662b773243d8a722258f43441c14..a83a90dae7a5cf269b21a5cb49e3c60f8fcfcba7 100644 --- a/Sample/ComponentBuilder/Profile2DComponents.h +++ b/Sample/ComponentBuilder/Profile2DComponents.h @@ -21,8 +21,7 @@ #include "Sample/ComponentBuilder/IRegistry.h" #include "Sample/Correlations/Profiles2D.h" -//! @class Profile2DComponents -//! @brief Predefined Fourier transformed distributions for functional tests. +//! Predefined Fourier transformed distributions for functional tests. class Profile2DComponents : public IRegistry<IProfile2D> { public: diff --git a/Tests/Functional/Mumufit/ClassicalTestFunctions.h b/Tests/Functional/Mumufit/ClassicalTestFunctions.h index bc7b5381691e86c1fed52fc0127338a180455612..39aa313acc639412be55b072683c19935dae875f 100644 --- a/Tests/Functional/Mumufit/ClassicalTestFunctions.h +++ b/Tests/Functional/Mumufit/ClassicalTestFunctions.h @@ -17,8 +17,7 @@ #include <vector> -//! @class StandaloneFitTest -//! @brief Collection of objective functions for minimization library testing. +//! Collection of objective functions for minimization library testing. //! Borrowed from StressFit test framework of http://root.cern.ch. namespace TestFunctions {