From 4ea9e1d0d9dde3ae3befe90edad64c167b9fe758 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de> Date: Sat, 27 Jun 2020 19:18:32 +0200 Subject: [PATCH] GUI/Doxygen: fix some file header comment blocks --- GUI/coregui/Models/DataViewUtils.cpp | 14 ++++++++++++++ .../FitWidgets/FitComparisonViewController.cpp | 14 ++++++++++++++ .../Views/FitWidgets/FitComparisonViewController.h | 14 ++++++++++++++ .../InstrumentWidgets/SpecularInstrumentEditor.cpp | 14 ++++++++++++++ .../Views/IntensityDataWidgets/ScientificPlot.cpp | 14 ++++++++++++++ GUI/coregui/Views/SampleDesigner/ViewTypes.h | 4 ++-- 6 files changed, 72 insertions(+), 2 deletions(-) diff --git a/GUI/coregui/Models/DataViewUtils.cpp b/GUI/coregui/Models/DataViewUtils.cpp index fbb4d8f2640..75b6f1492d9 100644 --- a/GUI/coregui/Models/DataViewUtils.cpp +++ b/GUI/coregui/Models/DataViewUtils.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file GUI/coregui/Models/DataViewUtils.cpp +//! @brief Implements functions in namespace DataViewUtils +//! +//! @homepage http://www.bornagainproject.org +//! @license GNU General Public License v3 or higher (see COPYING) +//! @copyright Forschungszentrum Jülich GmbH 2018 +//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS) +// +// ************************************************************************** // + #include "DataViewUtils.h" #include "Data1DViewItem.h" #include "DataItem.h" diff --git a/GUI/coregui/Views/FitWidgets/FitComparisonViewController.cpp b/GUI/coregui/Views/FitWidgets/FitComparisonViewController.cpp index bc6c850b0c4..ff02cbd260e 100644 --- a/GUI/coregui/Views/FitWidgets/FitComparisonViewController.cpp +++ b/GUI/coregui/Views/FitWidgets/FitComparisonViewController.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file GUI/coregui/Views/FitWidgets/FitComparisonViewController.cpp +//! @brief Implements classes DiffItemController, FitComparison1DViewController +//! +//! @homepage http://www.bornagainproject.org +//! @license GNU General Public License v3 or higher (see COPYING) +//! @copyright Forschungszentrum Jülich GmbH 2018 +//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS) +// +// ************************************************************************** // + #include "FitComparisonViewController.h" #include "AxesItems.h" #include "Data1DViewItem.h" diff --git a/GUI/coregui/Views/FitWidgets/FitComparisonViewController.h b/GUI/coregui/Views/FitWidgets/FitComparisonViewController.h index 18876de4cd2..59c7872d133 100644 --- a/GUI/coregui/Views/FitWidgets/FitComparisonViewController.h +++ b/GUI/coregui/Views/FitWidgets/FitComparisonViewController.h @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file GUI/coregui/Views/FitWidgets/FitComparisonViewController.h +//! @brief Defines classes DiffItemController, FitComparison1DViewController +//! +//! @homepage http://www.bornagainproject.org +//! @license GNU General Public License v3 or higher (see COPYING) +//! @copyright Forschungszentrum Jülich GmbH 2018 +//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS) +// +// ************************************************************************** // + #ifndef FITCOMPARISONVIEWCONTROLLER_H #define FITCOMPARISONVIEWCONTROLLER_H diff --git a/GUI/coregui/Views/InstrumentWidgets/SpecularInstrumentEditor.cpp b/GUI/coregui/Views/InstrumentWidgets/SpecularInstrumentEditor.cpp index af3ca4cbe91..b83ca53dbfe 100644 --- a/GUI/coregui/Views/InstrumentWidgets/SpecularInstrumentEditor.cpp +++ b/GUI/coregui/Views/InstrumentWidgets/SpecularInstrumentEditor.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file GUI/coregui/Views/InstrumentWidgets/SpecularInstrumentEditor.cpp +//! @brief Implements class SpecularInstrumentEditor +//! +//! @homepage http://www.bornagainproject.org +//! @license GNU General Public License v3 or higher (see COPYING) +//! @copyright Forschungszentrum Jülich GmbH 2018 +//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS) +// +// ************************************************************************** // + #include "SpecularInstrumentEditor.h" #include "ColumnResizer.h" #include "EnvironmentEditor.h" diff --git a/GUI/coregui/Views/IntensityDataWidgets/ScientificPlot.cpp b/GUI/coregui/Views/IntensityDataWidgets/ScientificPlot.cpp index f1be45cfd06..1cb3a19011b 100644 --- a/GUI/coregui/Views/IntensityDataWidgets/ScientificPlot.cpp +++ b/GUI/coregui/Views/IntensityDataWidgets/ScientificPlot.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file GUI/coregui/Views/IntensityDataWidgets/ScientificPlot.cpp +//! @brief Implements class ScientificPlot +//! +//! @homepage http://www.bornagainproject.org +//! @license GNU General Public License v3 or higher (see COPYING) +//! @copyright Forschungszentrum Jülich GmbH 2018 +//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS) +// +// ************************************************************************** // + #include "ScientificPlot.h" #include "ScientificPlotEvent.h" #include <qcustomplot.h> diff --git a/GUI/coregui/Views/SampleDesigner/ViewTypes.h b/GUI/coregui/Views/SampleDesigner/ViewTypes.h index 234b3d1c36c..8ea6c710a2c 100644 --- a/GUI/coregui/Views/SampleDesigner/ViewTypes.h +++ b/GUI/coregui/Views/SampleDesigner/ViewTypes.h @@ -2,8 +2,8 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file GUI/coregui/Views/SampleDesigner/IView.h -//! @brief Defines class IView +//! @file GUI/coregui/Views/SampleDesigner/ViewTypes.h +//! @brief Defines namespace ViewTypes with enum EWidgetTypes (nothing to implement) //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) -- GitLab