From a6d49737c835317640fb4c3fe39af75d07459ecd Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de> Date: Fri, 9 Jul 2021 14:31:43 +0200 Subject: [PATCH] rm internal classes form user docs --- Core/Fitting/FitObjective.h | 4 +++- Doc/Doxygen/user/mainpage.md | 11 ----------- Fit/Minimizer/MinimizerCatalog.h | 2 ++ Sample/Material/WavevectorInfo.h | 2 ++ Sample/Particle/FormFactorWeighted.h | 2 ++ 5 files changed, 9 insertions(+), 12 deletions(-) diff --git a/Core/Fitting/FitObjective.h b/Core/Fitting/FitObjective.h index 2f8ea35ef18..d8fef6cf178 100644 --- a/Core/Fitting/FitObjective.h +++ b/Core/Fitting/FitObjective.h @@ -15,6 +15,7 @@ #ifndef BORNAGAIN_CORE_FITTING_FITOBJECTIVE_H #define BORNAGAIN_CORE_FITTING_FITOBJECTIVE_H +#ifndef USER_API #include "Core/Fitting/IterationInfo.h" #include "Core/Fitting/SimDataPair.h" #include "Device/Data/ArrayUtils.h" @@ -130,7 +131,7 @@ public: bool isFirstIteration() const; void setObjectiveMetric(std::unique_ptr<ObjectiveMetric> metric); -#endif // USER_API +#endif // SWIG private: typedef std::vector<double> (SimDataPair::*DataPairAccessor)() const; @@ -144,3 +145,4 @@ private: }; #endif // BORNAGAIN_CORE_FITTING_FITOBJECTIVE_H +#endif // USER_API diff --git a/Doc/Doxygen/user/mainpage.md b/Doc/Doxygen/user/mainpage.md index 6e210cda4cf..b7814c61ec4 100644 --- a/Doc/Doxygen/user/mainpage.md +++ b/Doc/Doxygen/user/mainpage.md @@ -48,17 +48,6 @@ Fitting routines </ul> <br> -Here is a list of additional classes from internal API. -<ul> -<li> \ref simulation_internal "ISimulation and instrument internals" <br> -<li> \ref samples_internal "Samples internals" <br> -<li> \ref materials_internal "Materials internals" <br> -<li> \ref formfactors_internal "Form factors internals" <br> -<li> \ref distribution_internal "Distribution function internals" -<li> \ref tools_internal "Tools internals" <br> -<li> \ref fitting_internal "Fitting internals" <br> -</ul> - </div> ### See also diff --git a/Fit/Minimizer/MinimizerCatalog.h b/Fit/Minimizer/MinimizerCatalog.h index d8632c8a8e0..1bcd38051d0 100644 --- a/Fit/Minimizer/MinimizerCatalog.h +++ b/Fit/Minimizer/MinimizerCatalog.h @@ -12,6 +12,7 @@ // // ************************************************************************************************ +#ifndef USER_API #ifndef BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H #define BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H @@ -53,3 +54,4 @@ private: }; #endif // BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H +#endif // USER_API diff --git a/Sample/Material/WavevectorInfo.h b/Sample/Material/WavevectorInfo.h index f3e8ebae928..3c66ae495f8 100644 --- a/Sample/Material/WavevectorInfo.h +++ b/Sample/Material/WavevectorInfo.h @@ -12,6 +12,7 @@ // // ************************************************************************************************ +#ifndef USER_API #ifndef BORNAGAIN_SAMPLE_MATERIAL_WAVEVECTORINFO_H #define BORNAGAIN_SAMPLE_MATERIAL_WAVEVECTORINFO_H @@ -44,3 +45,4 @@ private: }; #endif // BORNAGAIN_SAMPLE_MATERIAL_WAVEVECTORINFO_H +#endif // USER_API diff --git a/Sample/Particle/FormFactorWeighted.h b/Sample/Particle/FormFactorWeighted.h index ed1f726bcf8..e3839e898c6 100644 --- a/Sample/Particle/FormFactorWeighted.h +++ b/Sample/Particle/FormFactorWeighted.h @@ -12,6 +12,7 @@ // // ************************************************************************************************ +#ifndef USER_API #ifndef BORNAGAIN_SAMPLE_PARTICLE_FORMFACTORWEIGHTED_H #define BORNAGAIN_SAMPLE_PARTICLE_FORMFACTORWEIGHTED_H @@ -57,3 +58,4 @@ protected: }; #endif // BORNAGAIN_SAMPLE_PARTICLE_FORMFACTORWEIGHTED_H +#endif // USER_API -- GitLab