[skip-ci] fix some doxygen warnings about undocumented params

Author: ferdymercury

core/base/src/TVirtualPad.cxx

@@ -41,6 +41,7 @@ TVirtualPad::TContext::TContext(Bool_t _interactive)
 
 ////////////////////////////////////////////////////////////////////////////////
 /// Constructor which stores gPad and set it to new value
+/// @param gpad pointer to current pad
 /// @param interactive defines how gPad will be restored: with cd() call (kTRUE) or just by assign gPad back
 /// @param not_null allows to set only pad which is not null
 

core/metacling/src/TCling.cxx

@@ -1335,6 +1335,7 @@ static void RegisterPreIncludedHeaders(cling::Interpreter &clingInterp)
 /// \param title title for TInterpreter
 /// \param argv - array of arguments passed to the cling::Interpreter constructor
 ///               e.g. `-DFOO=bar`. The last element of the array must be `nullptr`.
+/// \param interpLibHandle handle to interpreter library
 
 TCling::TCling(const char *name, const char *title, const char* const argv[], void *interpLibHandle)
 : TInterpreter(name, title), fGlobalsListSerial(-1), fMapfile(nullptr),

gui/webdisplay/src/RWebWindow.cxx

@@ -519,11 +519,12 @@ unsigned RWebWindow::AddDisplayHandle(bool headless_mode, const std::string &key
 
 //////////////////////////////////////////////////////////////////////////////////////////
 /// Check if provided hash, ntry parameters from the connection request could be accepted
-/// \param hash - provided hash value which should match with HMAC hash for generated before connection key
-/// \param ntry - connection attempt number provided together with request, must come in increasing order
-/// \param remote - boolean flag indicating if request comming from remote (via real http),
+/// \param conn shared pointer to the web connection
+/// \param hash provided hash value which should match with HMAC hash for generated before connection key
+/// \param ntry connection attempt number provided together with request, must come in increasing order
+/// \param remote boolean flag indicating if request comming from remote (via real http),
 ///                 for local displays like Qt5 or CEF simpler connection rules are applied
-/// \param test_first_time - true if hash/ntry tested for the first time, false appears only with
+/// \param test_first_time true if hash/ntry tested for the first time, false appears only with
 ///                          websocket when connection accepted by server
 
 bool RWebWindow::_CanTrustIn(std::shared_ptr<WebConn> &conn, const std::string &hash, const std::string &ntry, bool remote, bool test_first_time)

net/http/src/TRootSniffer.cxx

@@ -1509,6 +1509,7 @@ Bool_t TRootSniffer::CallProduceImage(const std::string &/*kind*/, const std::st
 /// * "exe.txt"   - method execution with debug output
 /// * "cmd.json"  - execution of registered commands
 ///
+/// @param options specific options 
 /// @param res returns result - binary or text.
 
 Bool_t TRootSniffer::Produce(const std::string &path, const std::string &file, const std::string &options, std::string &res)
@@ -1629,6 +1630,7 @@ TFolder *TRootSniffer::GetSubFolder(const char *subfolder, Bool_t force)
 ////////////////////////////////////////////////////////////////////////////////
 /// Register object in subfolder structure
 ///
+/// @param obj pointer to TObject
 /// @param subfolder can have many levels like:
 ///
 ///     TRootSniffer* sniff = new TRootSniffer("sniff");

net/httpsniff/src/TRootSnifferFull.cxx

@@ -529,9 +529,11 @@ Bool_t TRootSnifferFull::ProduceXml(const std::string &path, const std::string &
 ////////////////////////////////////////////////////////////////////////////////
 /// Execute command for specified object
 ///
-/// options include method and extra list of parameters
+/// @param path the object path
+/// @param options include method and extra list of parameters
 /// sniffer should be not-readonly to allow execution of the commands
 /// @param reskind defines kind of result 0 - debug, 1 - json, 2 - binary
+/// @param res_str result string
 
 Bool_t TRootSnifferFull::ProduceExe(const std::string &path, const std::string &options, Int_t reskind, std::string &res_str)
 {

roofit/batchcompute/src/CudaInterface.h

@@ -85,7 +85,7 @@ void copyDeviceToDeviceImpl(const void *src, void *dest, std::size_t n, CudaStre
  *
  * @param[in] src             Pointer to the source memory on the host.
  * @param[in] dest            Pointer to the destination memory on the device.
- * @param[in] nBytes          Number of bytes to copy.
+ * @param[in] n               Number of bytes to copy.
  * @param[in] stream          CudaStream for asynchronous memory transfer (optional).
  */
 template <class T>
@@ -99,7 +99,7 @@ void copyHostToDevice(const T *src, T *dest, std::size_t n, CudaStream * = nullp
  *
  * @param[in] src             Pointer to the source memory on the device.
  * @param[in] dest            Pointer to the destination memory on the host.
- * @param[in] nBytes          Number of bytes to copy.
+ * @param[in] n               Number of bytes to copy.
  * @param[in] stream          CudaStream for asynchronous memory transfer (optional).
  */
 template <class T>
@@ -113,7 +113,7 @@ void copyDeviceToHost(const T *src, T *dest, std::size_t n, CudaStream * = nullp
  *
  * @param[in] src             Pointer to the source memory on the device.
  * @param[in] dest            Pointer to the destination memory on the device.
- * @param[in] nBytes          Number of bytes to copy.
+ * @param[in] n               Number of bytes to copy.
  * @param[in] stream          CudaStream for asynchronous memory transfer (optional).
  */
 template <class T>

roofit/histfactory/src/HistFactoryImpl.cxx

@@ -34,12 +34,12 @@ namespace Detail {
  * ranges for the gamma parameter and provides a reasonable starting point for
  * pre-fit errors.
  *
- * @param gammas   The gamma parameters to be configured.
- * @param sigmaRel The relative sigma values to be used for configuring the
- *                 limits and errors.
- * @param minSigma The minimum relative sigma threshold. If a relative sigma is
- *                 below this threshold, the gamma parameter is set to be
- *                 constant.
+ * @param gammas    The gamma parameters to be configured.
+ * @param relSigmas The relative sigma values to be used for configuring the
+ *                  limits and errors.
+ * @param minSigma  The minimum relative sigma threshold. If a relative sigma is
+ *                  below this threshold, the gamma parameter is set to be
+ *                  constant.
  */
 void configureConstrainedGammas(RooArgList const &gammas, std::span<const double> relSigmas, double minSigma)
 {

roofit/histfactory/src/ParamHistFunc.cxx

@@ -556,10 +556,9 @@ double ParamHistFunc::evaluate() const
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-/// Find all bins corresponding to the values of the observables in `evalData`, and evaluate
-/// the associated parameters.
-/// \param[in,out] evalData Input/output data for evaluating the ParamHistFunc.
-/// \param[in] normSet Normalisation set passed on to objects that are serving values to us.
+/// Find all bins corresponding to the values of the observables in `ctx`,
+// and evaluate the associated parameters.
+/// \param[in,out] ctx Input/output data for evaluating the ParamHistFunc.
 void ParamHistFunc::doEval(RooFit::EvalContext & ctx) const
 {
   std::span<double> output = ctx.output();

roofit/histfactory/src/PiecewiseInterpolation.cxx

@@ -204,8 +204,7 @@ inline double broadcast(std::span<const double> const &s, std::size_t i)
 
 ////////////////////////////////////////////////////////////////////////////////
 /// Interpolate between input distributions for all values of the observable in `evalData`.
-/// \param[in,out] evalData Struct holding spans pointing to input data. The results of this function will be stored here.
-/// \param[in] normSet Arguments to normalise over.
+/// \param[in,out] ctx Struct holding spans pointing to input data. The results of this function will be stored here.
 void PiecewiseInterpolation::doEval(RooFit::EvalContext &ctx) const
 {
    std::span<double> sum = ctx.output();

roofit/roofitcore/src/RooAbsPdf.cxx

@@ -683,7 +683,7 @@ void RooAbsPdf::getLogProbabilities(std::span<const double> pdfValues, double *
 /// \param[in] sumEntries The number of observed events.
 /// \param[in] nset The normalization set when asking the pdf for the expected
 ///            number of events.
-/// \param[in] observedSumW2 The number of observed events when weighting with
+/// \param[in] sumEntriesW2 The number of observed events when weighting with
 ///            squared weights. If non-zero, the weight-squared error
 ///            correction is applied to the extended term.
 /// \param[in] doOffset Offset the extended term by a counterterm where the

roofit/roofitcore/src/RooBinSamplingPdf.cxx

@@ -158,8 +158,7 @@ double RooBinSamplingPdf::evaluate() const {
 
 ////////////////////////////////////////////////////////////////////////////////
 /// Integrate the PDF over all its bins, and return a batch with those values.
-/// \param[in,out] evalData Struct with evaluation data.
-/// \param[in] normSet Normalisation set that's used to evaluate the PDF.
+/// \param[in,out] ctx Struct with evaluation data
 void RooBinSamplingPdf::doEval(RooFit::EvalContext &ctx) const
 {
    std::span<double> output = ctx.output();

roofit/roofitcore/src/RooPolyFunc.cxx

@@ -223,6 +223,8 @@ void fixObservables(const RooAbsCollection &observables)
 //////////////////////////////////////////////////////////////////////////////
 /// Taylor expanding given function in terms of observables around
 /// observableValues. Supports expansions upto order 2.
+/// \param[in] name the name
+/// \param[in] title the title
 /// \param[in] func Function of variables that is taylor expanded.
 /// \param[in] observables Set of variables to perform the expansion.
 ///            It's type is RooArgList to ensure that it is always ordered the

tmva/pymva/src/PyMethodBase.cxx

@@ -404,7 +404,8 @@ std::vector<size_t> PyMethodBase::GetDataFromList(PyObject* listObject){
 ///        dictionary object and returns the associated value or throws runtime
 ///        error.
 ///
-/// \param[in] listObject Python Dict object
+/// \param[in] dict Python Dict object
+/// \param[in] key the key to search for in the dict
 /// \return Associated value PyObject
 PyObject *PyMethodBase::GetValueFromDict(PyObject *dict, const char *key)
 {

tmva/pymva/src/RModelParser_Keras.cxx

@@ -763,6 +763,7 @@ std::unique_ptr<ROperator> MakeKerasIdentity(PyObject* fLayer)
 
 //////////////////////////////////////////////////////////////////////////////////
 /// \param[in] filename file location of Keras .h5
+/// \param[in] batch_size if not given, 1 is used if the model does not provide it
 /// \return Parsed RModel object
 ///
 /// The `Parse()` function defined in `TMVA::Experimental::SOFIE::PyKeras` will

tree/dataframe/inc/ROOT/RDF/RLoopManager.hxx

@@ -308,6 +308,7 @@ public:
 /// \param[in] datasetName Name of the TChain
 /// \param[in] fileNameGlob File name (or glob) in which the TChain is stored.
 /// \param[in] defaultColumns List of default columns, see
+/// \param[in] checkFile file validator boolean
 /// \ref https://root.cern/doc/master/classROOT_1_1RDataFrame.html#default-branches "Default column lists"
 /// \return the RLoopManager instance.
 std::shared_ptr<ROOT::Detail::RDF::RLoopManager>
@@ -318,6 +319,7 @@ CreateLMFromTTree(std::string_view datasetName, std::string_view fileNameGlob,
 /// \param[in] datasetName Name of the TChain
 /// \param[in] fileNameGlobs List of file names (potentially globs).
 /// \param[in] defaultColumns List of default columns, see
+/// \param[in] checkFile file validator boolean
 /// \ref https://root.cern/doc/master/classROOT_1_1RDataFrame.html#default-branches "Default column lists"
 /// \return the RLoopManager instance.
 std::shared_ptr<ROOT::Detail::RDF::RLoopManager>

tree/dataframe/src/RDataFrame.cxx

@@ -1804,7 +1804,7 @@ RDataFrame::RDataFrame(std::string_view treeName, TDirectory *dirPtr, const Colu
 ////////////////////////////////////////////////////////////////////////////
 /// \brief Build the dataframe.
 /// \param[in] treeName Name of the tree contained in the directory
-/// \param[in] filenameglob TDirectory where the tree is stored, e.g. a TFile.
+/// \param[in] fileNameGlob TDirectory where the tree is stored, e.g. a TFile.
 /// \param[in] defaultColumns Collection of default columns.
 ///
 /// The filename glob supports the same type of expressions as TChain::Add(), and it is passed as-is to TChain's
@@ -1827,8 +1827,8 @@ RDataFrame::RDataFrame(std::string_view treeName, std::string_view fileNameGlob,
 
 ////////////////////////////////////////////////////////////////////////////
 /// \brief Build the dataframe.
-/// \param[in] treeName Name of the tree contained in the directory
-/// \param[in] fileglobs Collection of file names of filename globs
+/// \param[in] datasetName Name of the dataset contained in the directory
+/// \param[in] fileNameGlobs Collection of file names of filename globs
 /// \param[in] defaultColumns Collection of default columns.
 ///
 /// The filename globs support the same type of expressions as TChain::Add(), and each glob is passed as-is

tree/tree/src/InternalTreeUtils.cxx

@@ -417,7 +417,7 @@ std::vector<std::unique_ptr<TChain>> MakeFriends(const ROOT::TreeUtils::RFriendI
 ////////////////////////////////////////////////////////////////////////////////
 /// \brief Recursively expand the glob to take care of potential wildcard
 /// specials for subdirectories in the glob.
-/// \param[in] l The list of full paths to files.
+/// \param[in] out The list of full paths to files.
 /// \param[in] glob The glob to expand.
 /// \throws std::runtime_error If the directory parts of the glob refer to a
 ///         path that cannot be opened.
@@ -530,7 +530,7 @@ std::vector<std::string> ExpandGlob(const std::string &glob)
 ////////////////////////////////////////////////////////////////////////////////
 /// \brief Returns the cluster boundaries and number of entries of the input tree.
 /// \param[in] treename Name of the tree.
-/// \param[in] filename Path to the file.
+/// \param[in] path Path to the file.
 /// \return a pair (cluster_boundaries, n_entries). The vector of cluster
 ///         of cluster boundaries contains the beginning entry of the first
 ///         cluster up to the ending entry of the last cluster, e.g. for a tree