From d0e67d56e6ddd9c165735f012918131ef36852ac Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Mon, 5 Oct 2020 13:10:17 +0200
Subject: [PATCH] Doxygen/XML: cope with most annoying warning (\n -> <br>)
---
Fit/Kernel/PyCallback.h | 2 +-
Fit/RootAdapter/RootResidualFunction.h | 3 ---
Fit/Tools/WallclockTimer.cpp | 2 +-
Wrap/swig/DoxyfileSwig.in | 6 +++---
4 files changed, 5 insertions(+), 8 deletions(-)
diff --git a/Fit/Kernel/PyCallback.h b/Fit/Kernel/PyCallback.h
index 5d505f03105..abe18418879 100644
--- a/Fit/Kernel/PyCallback.h
+++ b/Fit/Kernel/PyCallback.h
@@ -39,7 +39,7 @@ public:
//! Call Python callable and returns its result. Intended to be overloaded in Python.
//! @param pars: Fit parameters object (intentionally passed by value).
//! @return vector of residuals
- virtual std::vector<double> call_residuals(Fit::Parameters);
+ virtual std::vector<double> call_residuals(Fit::Parameters pars);
private:
CallbackType m_callback_type;
diff --git a/Fit/RootAdapter/RootResidualFunction.h b/Fit/RootAdapter/RootResidualFunction.h
index aefbb822e22..cecd7f0892a 100644
--- a/Fit/RootAdapter/RootResidualFunction.h
+++ b/Fit/RootAdapter/RootResidualFunction.h
@@ -35,9 +35,6 @@ public:
typedef ROOT::Math::BasicFitMethodFunction<ROOT::Math::IMultiGenFunction>::Type_t Type_t;
//! Constructs RootResidualFunction
- //! @param fun_gradient: user function to call
- //! @param npars: number of fit parameters
- //! @param ndatasize: number of residual elements in dataset
RootResidualFunction(scalar_function_t objective_fun, gradient_function_t gradient_fun,
size_t npars, size_t ndatasize);
diff --git a/Fit/Tools/WallclockTimer.cpp b/Fit/Tools/WallclockTimer.cpp
index 22a6101d6cd..713b024195b 100644
--- a/Fit/Tools/WallclockTimer.cpp
+++ b/Fit/Tools/WallclockTimer.cpp
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file Fit/Tools/WallclockTimer.cpp
-//! @brief Implements WallclockTimer class.
+//! @brief Implements class WallclockTimer.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
diff --git a/Wrap/swig/DoxyfileSwig.in b/Wrap/swig/DoxyfileSwig.in
index 7e3a4f120f6..82a483d43e8 100644
--- a/Wrap/swig/DoxyfileSwig.in
+++ b/Wrap/swig/DoxyfileSwig.in
@@ -259,8 +259,8 @@ TAB_SIZE = 4
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
-ALIASES = "homepage=@par Homepage:\n" \
- "license=@par License:\n"
+ALIASES = "homepage=@par Homepage:<br>" \
+ "license=@par License:<br>"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
@@ -807,7 +807,7 @@ WARN_NO_PARAMDOC = NO
# a warning is encountered.
# The default value is: NO.
-WARN_AS_ERROR = YES
+WARN_AS_ERROR = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
--
GitLab