diff --git a/Core/Beam/FootprintFactorGaussian.cpp b/Core/Beam/FootprintFactorGaussian.cpp index 2b471b8eb24841cba0e859308c0327abcdbeebb1..ec2a4900c24f68560c1c33118c77efb4337ac30d 100644 --- a/Core/Beam/FootprintFactorGaussian.cpp +++ b/Core/Beam/FootprintFactorGaussian.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Beam/FootprintFactorGaussian.cpp +//! @brief Implements class FootprintFactorGaussian. +//! +//! @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 "FootprintFactorGaussian.h" #include "MathConstants.h" #include "MathFunctions.h" diff --git a/Core/Beam/FootprintFactorSquare.cpp b/Core/Beam/FootprintFactorSquare.cpp index 3a23a6ccf99944fda17d192db8898ebb8f11e65a..c18747e75d658e2f20af3839f946e220fc138a37 100644 --- a/Core/Beam/FootprintFactorSquare.cpp +++ b/Core/Beam/FootprintFactorSquare.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Beam/FootprintFactorSquare.cpp +//! @brief Implements class FootprintFactorSquare. +//! +//! @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 "FootprintFactorSquare.h" #include "MathConstants.h" #include "PythonFormatting.h" diff --git a/Core/Beam/IFootprintFactor.cpp b/Core/Beam/IFootprintFactor.cpp index 3d0bbb2b3424e33eeccbfb09e5f71c26cced7bf8..68a7c1b6c9edaf6fb06ebd2818f06b5c3a1a2d73 100644 --- a/Core/Beam/IFootprintFactor.cpp +++ b/Core/Beam/IFootprintFactor.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Beam/IFootprintFactor.cpp +//! @brief Implements class IFootprintFactor. +//! +//! @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 "IFootprintFactor.h" #include "RealParameter.h" #include <stdexcept> diff --git a/Core/Beam/IFootprintFactor.h b/Core/Beam/IFootprintFactor.h index d549e7838a9f03f6fd0f6ac59e5c10f36a5e348b..f63d900d6f393452a175f041268a00ee09a31b17 100644 --- a/Core/Beam/IFootprintFactor.h +++ b/Core/Beam/IFootprintFactor.h @@ -21,7 +21,7 @@ class MultiLayer; class Beam; -//! Defines the base for classes to calculate beam footprint factor +//! Abstract base for classes that calculate the beam footprint factor //! @ingroup simulation class BA_CORE_API_ IFootprintFactor : public ICloneable, public INode diff --git a/Core/Fitting/FitObserver.h b/Core/Fitting/FitObserver.h index 004b387817307fce9df7a66e7e87e06f763fbd2b..4fb76ababc51e34ef97d743df7ed5cdb62dd32bd 100644 --- a/Core/Fitting/FitObserver.h +++ b/Core/Fitting/FitObserver.h @@ -3,7 +3,7 @@ // BornAgain: simulate and fit scattering at grazing incidence // //! @file Core/Fitting/FitObserver.h -//! @brief Defines class FitStatusObserver. +//! @brief Defines class FitObserver. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -96,4 +96,3 @@ bool FitObserver<T>::need_notify(int every_nth) } #endif // FITOBSERVER_H - diff --git a/Core/Instrument/PyArrayImportUtils.cpp b/Core/Instrument/PyArrayImportUtils.cpp index 70c4c7e75d140e146cd2b7dd0ebd7ac811ed416c..22326799c234d2c9600fc0807444c828cd1ded72 100644 --- a/Core/Instrument/PyArrayImportUtils.cpp +++ b/Core/Instrument/PyArrayImportUtils.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Instrument/PyArrayImportUtils.cpp +//! @brief Implements functions in namespace PyArrayImport +//! +//! @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 "PyArrayImportUtils.h" #include "ArrayUtils.h" diff --git a/Core/Instrument/PyArrayImportUtils.h b/Core/Instrument/PyArrayImportUtils.h index af9093b3db9c531d6d31d63a5ee1c3605c93780d..4c93e68194e9bcb3bfa9bac8e6a3b565f9a00dc9 100644 --- a/Core/Instrument/PyArrayImportUtils.h +++ b/Core/Instrument/PyArrayImportUtils.h @@ -3,7 +3,7 @@ // BornAgain: simulate and fit scattering at grazing incidence // //! @file Core/Instrument/PyArrayImportUtils.h -//! @brief Defines various functions to interact from numpy on Python side +//! @brief Declares functions in namespace PyArrayImport. //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -20,13 +20,16 @@ template<class T> class OutputData; -//! Set of functions for numpy array import to OutputData. Required solely -//! as a shortcut to produce OutputData from numpy arrays of doubles +//! Functions for numpy array import to OutputData. +//! Required solely as a shortcut to produce OutputData from numpy arrays of doubles. namespace PyArrayImport { - //! Provides functionality for importing 1D or 2D arrays of doubles from python into OutputData + + //! for importing 1D array of doubles from python into OutputData BA_CORE_API_ OutputData<double>* importArrayToOutputData(const std::vector<double>& vec); + //! for importing 2D array of doubles from python into OutputData BA_CORE_API_ OutputData<double>* importArrayToOutputData(const std::vector<std::vector<double>>& vec); -} + +} // namespace PyArrayImport #endif // PYARRAYIMPORTUTILS_H diff --git a/Core/Material/MaterialUtils.cpp b/Core/Material/MaterialUtils.cpp index 346b2e4f7b5fee081a6604a1ba571bdff656c6ce..5046f5a8c561d93fd0d9da1932934a6a8b6311ed 100644 --- a/Core/Material/MaterialUtils.cpp +++ b/Core/Material/MaterialUtils.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Material/MaterialUtils.cpp +//! @brief Implements functions in namespace MaterialUtils +//! +//! @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 "MaterialUtils.h" #include "PhysicalConstants.h" #include "Material.h" diff --git a/Core/Material/MaterialUtils.h b/Core/Material/MaterialUtils.h index b18aab68aec6092123b6bebc083207daef2e626b..d21ec178c71ff23ea1227fd52f8e0098568eb267 100644 --- a/Core/Material/MaterialUtils.h +++ b/Core/Material/MaterialUtils.h @@ -3,7 +3,7 @@ // BornAgain: simulate and fit scattering at grazing incidence // //! @file Core/Material/MaterialUtils.h -//! @brief materials-related global functions and utilities +//! @brief Declares functions in namespace MaterialUtils //! //! @homepage http://www.bornagainproject.org //! @license GNU General Public License v3 or higher (see COPYING) @@ -20,7 +20,7 @@ #include "EigenCore.h" #include "Material.h" -//! A number of helper functions for internal use +//! A number of materials-related helper functions for internal use //! @ingroup materials namespace MaterialUtils { @@ -46,6 +46,7 @@ BA_CORE_API_ Eigen::Matrix2cd MagnetizationCorrection(complex_t unit_factor, dou //! If several types of materials are involved, InvalidMaterialType identifier is returned. BA_CORE_API_ MATERIAL_TYPES checkMaterialTypes(const std::vector<const Material*>& materials); -} + +} // namespace MaterialUtils #endif /* MATERIALUTILS_H_ */ diff --git a/Core/Material/RefractiveMaterialImpl.cpp b/Core/Material/RefractiveMaterialImpl.cpp index 09199af8519b9b88f0c419c1787d5ec21556ecb4..958dbca50fe736add4efa37b9c3723523187e3b5 100644 --- a/Core/Material/RefractiveMaterialImpl.cpp +++ b/Core/Material/RefractiveMaterialImpl.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/Material/RefractiveMaterialImpl.cpp +//! @brief Implements class RefractiveMaterialImpl. +//! +//! @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 "RefractiveMaterialImpl.h" #include "WavevectorInfo.h" diff --git a/Core/SimulationElement/DepthProbeElement.cpp b/Core/SimulationElement/DepthProbeElement.cpp index 7c18ad0cb91b7a60cb8f8f1f60b6bf774ec0f49f..237a099abd02afe7a3aa8829cceaa9c47bf1bde6 100644 --- a/Core/SimulationElement/DepthProbeElement.cpp +++ b/Core/SimulationElement/DepthProbeElement.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/SimulationElement/DepthProbeElement.cpp +//! @brief Implements class DepthProbeElement. +//! +//! @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 "DepthProbeElement.h" #include "IAxis.h" diff --git a/Core/SimulationElement/PolarizationHandler.cpp b/Core/SimulationElement/PolarizationHandler.cpp index 368ff444573d385ffc4951386b911f490cc91466..7a2b746164d4ee4ec3682d893c17003ddcc1e1e8 100644 --- a/Core/SimulationElement/PolarizationHandler.cpp +++ b/Core/SimulationElement/PolarizationHandler.cpp @@ -1,3 +1,17 @@ +// ************************************************************************** // +// +// BornAgain: simulate and fit scattering at grazing incidence +// +//! @file Core/SimulationElement/PolarizationHandler.cpp +//! @brief Implements class PolarizationHandler. +//! +//! @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 "PolarizationHandler.h" PolarizationHandler::PolarizationHandler() @@ -11,4 +25,3 @@ void PolarizationHandler::swapContent(PolarizationHandler& other) std::swap(m_polarization, other.m_polarization); std::swap(m_analyzer_operator, other.m_analyzer_operator); } -