From b80845f68481c95ffbf50fc81166a00d76a6f9a8 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (l)" <j.wuttke@fz-juelich.de> Date: Sat, 20 Aug 2016 10:53:17 +0200 Subject: [PATCH] Class comments; update '@file'. --- Core/Aggregate/FormFactorInfo.cpp | 2 +- Core/Aggregate/FormFactorInfo.h | 2 +- Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorDebyeWaller.h | 2 +- Core/FFDecorators/FormFactorDecoratorFactor.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorFactor.h | 2 +- Core/FFDecorators/FormFactorDecoratorMaterial.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorMaterial.h | 2 +- .../FormFactorDecoratorMultiPositionFactor.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h | 2 +- Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorPositionFactor.h | 2 +- Core/FFDecorators/FormFactorDecoratorRotation.cpp | 2 +- Core/FFDecorators/FormFactorDecoratorRotation.h | 2 +- Core/FFDecorators/IFormFactorDecorator.h | 2 +- Core/Multilayer/DWBADiffuseReflection.cpp | 2 +- Core/Multilayer/DWBADiffuseReflection.h | 2 +- Core/Multilayer/DecouplingApproximationStrategy.cpp | 2 +- Core/Multilayer/DecouplingApproximationStrategy.h | 2 +- Core/Multilayer/FormFactorDWBA.cpp | 2 +- Core/Multilayer/FormFactorDWBA.h | 2 +- Core/Multilayer/FormFactorDWBAPol.cpp | 2 +- Core/Multilayer/FormFactorDWBAPol.h | 2 +- Core/Multilayer/IInterferenceFunctionStrategy.cpp | 2 +- Core/Multilayer/IInterferenceFunctionStrategy.h | 2 +- Core/Multilayer/ISpecularInfoMap.h | 2 +- Core/Multilayer/InterferenceFunctionStrategies.h | 2 +- .../SizeSpacingCorrelationApproximationStrategy.cpp | 2 +- .../SizeSpacingCorrelationApproximationStrategy.h | 2 +- Core/Parametrization/DistributionHandler.cpp | 2 +- Core/Parametrization/DistributionHandler.h | 2 +- Core/Sample/IFormFactor.cpp | 2 +- Core/Sample/IFormFactor.h | 7 ++++++- Core/Sample/IFormFactorBorn.cpp | 2 +- Core/Sample/IFormFactorBorn.h | 4 ++-- Core/Sample/Rotations.cpp | 2 +- Core/Sample/Rotations.h | 2 +- 37 files changed, 43 insertions(+), 38 deletions(-) diff --git a/Core/Aggregate/FormFactorInfo.cpp b/Core/Aggregate/FormFactorInfo.cpp index 24f18d0623c..688c479aa4c 100644 --- a/Core/Aggregate/FormFactorInfo.cpp +++ b/Core/Aggregate/FormFactorInfo.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/FormFactorInfo.cpp +//! @file Core/Aggregate/FormFactorInfo.cpp //! @brief Implements class FormFactorInfo. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Aggregate/FormFactorInfo.h b/Core/Aggregate/FormFactorInfo.h index 46cc1be6308..bb9f2893606 100644 --- a/Core/Aggregate/FormFactorInfo.h +++ b/Core/Aggregate/FormFactorInfo.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/FormFactorInfo.h +//! @file Core/Aggregate/FormFactorInfo.h //! @brief Defines class FormFactorInfo. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp b/Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp index 55d66b11b28..397b7402c27 100644 --- a/Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp +++ b/Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorDebyeWaller.cpp +//! @file Core/FFDecorators/FormFactorDecoratorDebyeWaller.cpp //! @brief Implements class FormFactorDecoratorDebyeWaller. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorDebyeWaller.h b/Core/FFDecorators/FormFactorDecoratorDebyeWaller.h index 9381d6cf9b5..843fcb93c20 100644 --- a/Core/FFDecorators/FormFactorDecoratorDebyeWaller.h +++ b/Core/FFDecorators/FormFactorDecoratorDebyeWaller.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorDebyeWaller.h +//! @file Core/FFDecorators/FormFactorDecoratorDebyeWaller.h //! @brief Defines and implements class FormFactorDecoratorDebyeWaller. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorFactor.cpp b/Core/FFDecorators/FormFactorDecoratorFactor.cpp index 62e7ef595c3..863c104dc94 100644 --- a/Core/FFDecorators/FormFactorDecoratorFactor.cpp +++ b/Core/FFDecorators/FormFactorDecoratorFactor.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorFactor.cpp +//! @file Core/FFDecorators/FormFactorDecoratorFactor.cpp //! @brief Implements class FormFactorDecoratorFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorFactor.h b/Core/FFDecorators/FormFactorDecoratorFactor.h index 23015b4e085..4f0b9d94a2d 100644 --- a/Core/FFDecorators/FormFactorDecoratorFactor.h +++ b/Core/FFDecorators/FormFactorDecoratorFactor.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorFactor.h +//! @file Core/FFDecorators/FormFactorDecoratorFactor.h //! @brief Defines class FormFactorDecoratorFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorMaterial.cpp b/Core/FFDecorators/FormFactorDecoratorMaterial.cpp index 61ee208c405..33d01925882 100644 --- a/Core/FFDecorators/FormFactorDecoratorMaterial.cpp +++ b/Core/FFDecorators/FormFactorDecoratorMaterial.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorMaterial.cpp +//! @file Core/FFDecorators/FormFactorDecoratorMaterial.cpp //! @brief Implements class FormFactorDecoratorMaterial. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorMaterial.h b/Core/FFDecorators/FormFactorDecoratorMaterial.h index 9453b0a5aba..d1fa23d4a77 100644 --- a/Core/FFDecorators/FormFactorDecoratorMaterial.h +++ b/Core/FFDecorators/FormFactorDecoratorMaterial.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorMaterial.h +//! @file Core/FFDecorators/FormFactorDecoratorMaterial.h //! @brief Defines class FormFactorDecoratorMaterial. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.cpp b/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.cpp index 09581081388..19941b6591a 100644 --- a/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.cpp +++ b/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorMultiPositionFactor.cpp +//! @file Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.cpp //! @brief Implements class FormFactorDecoratorMultiPositionFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h b/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h index c1224221b4d..052231fb662 100644 --- a/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h +++ b/Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorMultiPositionFactor.h +//! @file Core/FFDecorators/FormFactorDecoratorMultiPositionFactor.h //! @brief Defines class FormFactorDecoratorMultiPositionFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp b/Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp index 6390391504f..96bee0508e7 100644 --- a/Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp +++ b/Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorPositionFactor.cpp +//! @file Core/FFDecorators/FormFactorDecoratorPositionFactor.cpp //! @brief Implements class FormFactorDecoratorPositionFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorPositionFactor.h b/Core/FFDecorators/FormFactorDecoratorPositionFactor.h index f40d0c1e2cd..87b9c928920 100644 --- a/Core/FFDecorators/FormFactorDecoratorPositionFactor.h +++ b/Core/FFDecorators/FormFactorDecoratorPositionFactor.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorPositionFactor.h +//! @file Core/FFDecorators/FormFactorDecoratorPositionFactor.h //! @brief Defines class FormFactorDecoratorPositionFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorRotation.cpp b/Core/FFDecorators/FormFactorDecoratorRotation.cpp index 12349a97515..8292a8051ba 100644 --- a/Core/FFDecorators/FormFactorDecoratorRotation.cpp +++ b/Core/FFDecorators/FormFactorDecoratorRotation.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorRotation.cpp +//! @file Core/FFDecorators/FormFactorDecoratorRotation.cpp //! @brief Implements class FormFactorDecoratorRotation //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/FormFactorDecoratorRotation.h b/Core/FFDecorators/FormFactorDecoratorRotation.h index c9a4b9c9d20..7d98b935e69 100644 --- a/Core/FFDecorators/FormFactorDecoratorRotation.h +++ b/Core/FFDecorators/FormFactorDecoratorRotation.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDecoratorRotation.h +//! @file Core/FFDecorators/FormFactorDecoratorRotation.h //! @brief Defines class FormFactorDecoratorRotation. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/FFDecorators/IFormFactorDecorator.h b/Core/FFDecorators/IFormFactorDecorator.h index b92f87a853c..8e394829abe 100644 --- a/Core/FFDecorators/IFormFactorDecorator.h +++ b/Core/FFDecorators/IFormFactorDecorator.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/IFormFactorDecorator.h +//! @file Core/FFDecorators/IFormFactorDecorator.h //! @brief Defines pure virtual interface class IFormFactorDecorator. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/DWBADiffuseReflection.cpp b/Core/Multilayer/DWBADiffuseReflection.cpp index 057c7c47461..10c8595916d 100644 --- a/Core/Multilayer/DWBADiffuseReflection.cpp +++ b/Core/Multilayer/DWBADiffuseReflection.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Simulation/DWBADiffuseReflection.cpp +//! @file Core/Multilayer/DWBADiffuseReflection.cpp //! @brief Implements class DWBADiffuseReflection. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/DWBADiffuseReflection.h b/Core/Multilayer/DWBADiffuseReflection.h index 3d3883472ad..5b3e872449e 100644 --- a/Core/Multilayer/DWBADiffuseReflection.h +++ b/Core/Multilayer/DWBADiffuseReflection.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Simulation/DWBADiffuseReflection.h +//! @file Core/Multilayer/DWBADiffuseReflection.h //! @brief Defines class DWBADiffuseReflection. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/DecouplingApproximationStrategy.cpp b/Core/Multilayer/DecouplingApproximationStrategy.cpp index b3b34ad6b71..9ce0e3b5303 100644 --- a/Core/Multilayer/DecouplingApproximationStrategy.cpp +++ b/Core/Multilayer/DecouplingApproximationStrategy.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/DecouplingApproximationStrategy.cpp +//! @file Core/Multilayer/DecouplingApproximationStrategy.cpp //! @brief Implements class DecouplingApproximationStrategy. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/DecouplingApproximationStrategy.h b/Core/Multilayer/DecouplingApproximationStrategy.h index 6d5ecaeaaae..424ba380f61 100644 --- a/Core/Multilayer/DecouplingApproximationStrategy.h +++ b/Core/Multilayer/DecouplingApproximationStrategy.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/DecouplingApproximationStrategy.h +//! @file Core/Multilayer/DecouplingApproximationStrategy.h //! @brief Defines class DecouplingApproximationStrategy. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/FormFactorDWBA.cpp b/Core/Multilayer/FormFactorDWBA.cpp index b51e7eefa07..af573d1f124 100644 --- a/Core/Multilayer/FormFactorDWBA.cpp +++ b/Core/Multilayer/FormFactorDWBA.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDWBA.cpp +//! @file Core/Multilayer/FormFactorDWBA.cpp //! @brief Implements class FormFactorDWBA. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/FormFactorDWBA.h b/Core/Multilayer/FormFactorDWBA.h index 870837958b8..eabfcdf3954 100644 --- a/Core/Multilayer/FormFactorDWBA.h +++ b/Core/Multilayer/FormFactorDWBA.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDWBA.h +//! @file Core/Multilayer/FormFactorDWBA.h //! @brief Defines class FormFactorDWBA. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/FormFactorDWBAPol.cpp b/Core/Multilayer/FormFactorDWBAPol.cpp index 0f6161ab4a6..62cebeee808 100644 --- a/Core/Multilayer/FormFactorDWBAPol.cpp +++ b/Core/Multilayer/FormFactorDWBAPol.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDWBAPol.cpp +//! @file Core/Multilayer/FormFactorDWBAPol.cpp //! @brief Defines class FormFactorDWBAPol. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/FormFactorDWBAPol.h b/Core/Multilayer/FormFactorDWBAPol.h index f2082a7064e..f5d3b66df49 100644 --- a/Core/Multilayer/FormFactorDWBAPol.h +++ b/Core/Multilayer/FormFactorDWBAPol.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/FormFactor/FormFactorDWBAPol.h +//! @file Core/Multilayer/FormFactorDWBAPol.h //! @brief Defines class FormFactorDWBAPol. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/IInterferenceFunctionStrategy.cpp b/Core/Multilayer/IInterferenceFunctionStrategy.cpp index f52482dbf84..1bb19eb89a8 100644 --- a/Core/Multilayer/IInterferenceFunctionStrategy.cpp +++ b/Core/Multilayer/IInterferenceFunctionStrategy.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/IInterferenceFunctionStrategy.cpp +//! @file Core/Multilayer/IInterferenceFunctionStrategy.cpp //! @brief Implements default behaviour of IInterferenceFunctionStrategy //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/IInterferenceFunctionStrategy.h b/Core/Multilayer/IInterferenceFunctionStrategy.h index 837ed526fde..1b7de4185d1 100644 --- a/Core/Multilayer/IInterferenceFunctionStrategy.h +++ b/Core/Multilayer/IInterferenceFunctionStrategy.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/IInterferenceFunctionStrategy.h +//! @file Core/Multilayer/IInterferenceFunctionStrategy.h //! @brief Defines class IInterferenceFunctionStrategy. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/ISpecularInfoMap.h b/Core/Multilayer/ISpecularInfoMap.h index e18fa3e81ce..a81f38d7472 100644 --- a/Core/Multilayer/ISpecularInfoMap.h +++ b/Core/Multilayer/ISpecularInfoMap.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Simulation/ISpecularInfoMap.h +//! @file Core/Multilayer/ISpecularInfoMap.h //! @brief Defines and implements interface ISpecularInfoMap. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/InterferenceFunctionStrategies.h b/Core/Multilayer/InterferenceFunctionStrategies.h index 9790898d33b..ba05cd1abe4 100644 --- a/Core/Multilayer/InterferenceFunctionStrategies.h +++ b/Core/Multilayer/InterferenceFunctionStrategies.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/InterferenceFunctionStrategies.h +//! @file Core/Multilayer/InterferenceFunctionStrategies.h //! @brief Includes several files named *Strategy.h //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.cpp b/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.cpp index 2b7f511c99f..8725e293692 100644 --- a/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.cpp +++ b/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/SizeSpacingCorrelationApproximationStrategy.cpp +//! @file Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.cpp //! @brief Implements class SizeSpacingCorrelationApproximationStrategy. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.h b/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.h index f411f4dff3e..ad9d20e5419 100644 --- a/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.h +++ b/Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Aggregate/SizeSpacingCorrelationApproximationStrategy.h +//! @file Core/Multilayer/SizeSpacingCorrelationApproximationStrategy.h //! @brief Defines class SizeSpacingCorrelationApproximationStrategy. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Parametrization/DistributionHandler.cpp b/Core/Parametrization/DistributionHandler.cpp index 40c6f1a7990..1aa35d19bb9 100644 --- a/Core/Parametrization/DistributionHandler.cpp +++ b/Core/Parametrization/DistributionHandler.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Simulation/DistributionHandler.cpp +//! @file Core/Parametrization/DistributionHandler.cpp //! @brief Implements class DistributionHandler. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Parametrization/DistributionHandler.h b/Core/Parametrization/DistributionHandler.h index f7eddffa6e2..34e4adf8804 100644 --- a/Core/Parametrization/DistributionHandler.h +++ b/Core/Parametrization/DistributionHandler.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Simulation/DistributionHandler.h +//! @file Core/Parametrization/DistributionHandler.h //! @brief Defines class DistributionHandler. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Sample/IFormFactor.cpp b/Core/Sample/IFormFactor.cpp index 430b288d06d..b60b86b429b 100644 --- a/Core/Sample/IFormFactor.cpp +++ b/Core/Sample/IFormFactor.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/IFormFactor.cpp +//! @file Core/Sample/IFormFactor.cpp //! @brief Implements interface class IFormFactor. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Sample/IFormFactor.h b/Core/Sample/IFormFactor.h index f1e04327239..2480c96fb2d 100644 --- a/Core/Sample/IFormFactor.h +++ b/Core/Sample/IFormFactor.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Multilayer/IFormFactor.h +//! @file Core/Sample/IFormFactor.h //! @brief Defines and implements pure virtual interface IFormFactor. //! //! @homepage http://www.bornagainproject.org @@ -25,9 +25,14 @@ class ILayerRTCoefficients; class WavevectorInfo; //! Pure virtual base class for all form factors. +//! //! The actual form factor is returned by the complex valued function IFormFactor::evaluate, //! which depends on the incoming and outgoing wave vectors ki and kf. //! If it only depends on the scattering vector q=ki-kf, then it is a IBornFormFactor. +//! +//! Other children besides IBornFormFactor are IFormFactorDecorator, FormFactorWeighted, +//! FormFactorDWBAPol. + //! @ingroup formfactors_internal class BA_CORE_API_ IFormFactor : public ISample diff --git a/Core/Sample/IFormFactorBorn.cpp b/Core/Sample/IFormFactorBorn.cpp index fe886c11f57..3eaa3ead941 100644 --- a/Core/Sample/IFormFactorBorn.cpp +++ b/Core/Sample/IFormFactorBorn.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Particle/IFormFactorBorn.cpp +//! @file Core/Sample/IFormFactorBorn.cpp //! @brief Implements interface class IFormFactorBorn. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Sample/IFormFactorBorn.h b/Core/Sample/IFormFactorBorn.h index 2ebde46befb..8ec2537cd57 100644 --- a/Core/Sample/IFormFactorBorn.h +++ b/Core/Sample/IFormFactorBorn.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Particle/IFormFactorBorn.h +//! @file Core/Sample/IFormFactorBorn.h //! @brief Defines pure virtual interface class IFormFactorBorn. //! //! @homepage http://www.bornagainproject.org @@ -20,7 +20,7 @@ #include "Vectors3D.h" //! Pure virtual base class for Born form factors. -//! In contrast to a generic form factor, a Born form factor does not depend +//! In contrast to the generic IFormFactor, a Born form factor does not depend //! on the incoming and outgoing wave vectors ki and kf, except through their //! difference, the scattering vector q=ki-kf. //! @ingroup formfactors_internal diff --git a/Core/Sample/Rotations.cpp b/Core/Sample/Rotations.cpp index fe245537670..7edbf4ecf62 100644 --- a/Core/Sample/Rotations.cpp +++ b/Core/Sample/Rotations.cpp @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Rotation/Rotations.cpp +//! @file Core/Sample/Rotations.cpp //! @brief Implements IRotation classes. //! //! @homepage http://www.bornagainproject.org diff --git a/Core/Sample/Rotations.h b/Core/Sample/Rotations.h index 885d90651dc..711e1d5d2a3 100644 --- a/Core/Sample/Rotations.h +++ b/Core/Sample/Rotations.h @@ -2,7 +2,7 @@ // // BornAgain: simulate and fit scattering at grazing incidence // -//! @file Core/Rotation/Rotations.h +//! @file Core/Sample/Rotations.h //! @brief Defines IRotation classes. //! //! @homepage http://www.bornagainproject.org -- GitLab