From 1198ee3e08c46d1edc9258dbe857f66340f53a20 Mon Sep 17 00:00:00 2001 From: Mattias Ellert Date: Wed, 8 Jul 2020 10:39:54 +0200 Subject: [PATCH 2/5] Fix various "end of ..." warnings from doxygen. This addresses warnings like: - end of comment block while expecting command - end of comment block while expecting command - end of comment block while expecting command - end of comment block while expecting command - end of comment block while expecting command - end of comment block while expecting command - end of comment block while expecting command - end of list marker found without any preceding list items - found tag without matching - found tag without matching
  • - found tag without matching 
    - found  tag while expecting 
- found  tag without matching 
- found  tag without matching 
- found  tag without matching
    , append an opening 
    +/// Prepend a closing \, append an opening \
 
 Bool_t TDocHtmlDirective::GetResult(TString& result)
 {
diff --git a/math/mathcore/inc/Math/ProbFuncMathCore.h b/math/mathcore/inc/Math/ProbFuncMathCore.h
index d751c47a36..16e205347c 100644
--- a/math/mathcore/inc/Math/ProbFuncMathCore.h
+++ b/math/mathcore/inc/Math/ProbFuncMathCore.h
@@ -41,8 +41,8 @@ namespace Math {
    * These names are currently kept for backward compatibility, but
    * their usage is deprecated.
    *
-   *  These functions are defined in the header file Math/ProbFunc.h or in the global one
-   *  including all statistical functions Math/DistFunc.h
+   *  These functions are defined in the header file Math/ProbFunc.h or in the global one
+   *  including all statistical functions Math/DistFunc.h
    *
    */
 
@@ -727,8 +727,8 @@ namespace Math {
    first or the second momentum of the truncated distribution.
    In the case of the Landau, first and second momentum functions are provided for the Landau
    distribution truncated only on the right side.
-   These functions are defined in the header file Math/ProbFunc.h or in the global one
-   including all statistical functions Math/StatFunc.h
+   These functions are defined in the header file Math/ProbFunc.h or in the global one
+   including all statistical functions Math/StatFunc.h
 
    */
 
diff --git a/math/mathcore/inc/Math/QuantFuncMathCore.h b/math/mathcore/inc/Math/QuantFuncMathCore.h
index 7da5bd1178..1be023b33f 100644
--- a/math/mathcore/inc/Math/QuantFuncMathCore.h
+++ b/math/mathcore/inc/Math/QuantFuncMathCore.h
@@ -41,8 +41,8 @@ namespace Math {
    *
    *  \f[ D(x) = \int_{x}^{+\infty} p(x') dx' \f]
    *
-   *  These functions are defined in the header file Math/ProbFunc.h or in the global one
-   *  including all statistical functions Math/DistFunc.h
+   *  These functions are defined in the header file Math/ProbFunc.h or in the global one
+   *  including all statistical functions Math/DistFunc.h
    *
    *
    * NOTE: In the old releases (< 5.14) the _quantile functions were called
diff --git a/math/mathcore/src/TMath.cxx b/math/mathcore/src/TMath.cxx
index 49a81d56f7..ba8799b570 100644
--- a/math/mathcore/src/TMath.cxx
+++ b/math/mathcore/src/TMath.cxx
@@ -857,7 +857,7 @@ Double_t TMath::KolmogorovTest(Int_t na, const Double_t *a, Int_t nb, const Doub
 /// \f[
 /// lorentz(xx) = \frac{ \frac{1}{\pi} \frac{lg}{2} }{ (xx^{2} + \frac{lg^{2}}{4}) }
 /// \f]
-/// .
+/// \.
 ///
 /// The Voigt function is known to be the real part of Faddeeva function also
 /// called complex error function [2].
diff --git a/math/mathmore/inc/Math/GSLMultiRootFinder.h b/math/mathmore/inc/Math/GSLMultiRootFinder.h
index 42069d2387..b7efe4157d 100644
--- a/math/mathmore/inc/Math/GSLMultiRootFinder.h
+++ b/math/mathmore/inc/Math/GSLMultiRootFinder.h
@@ -69,23 +69,23 @@ namespace Math {
      documentation )
      are the followings:
      
      
-         
    • ROOT::Math::GSLMultiRootFinder::kHybridSJ  with name "HybridSJ": modified Powell's hybrid
+         
    • ROOT::Math::GSLMultiRootFinder::kHybridSJ  with name "HybridSJ": modified Powell's hybrid
      method as implemented in HYBRJ in MINPACK
-         
    • ROOT::Math::GSLMultiRootFinder::kHybridJ  with name "HybridJ": unscaled version of the
+         
    • ROOT::Math::GSLMultiRootFinder::kHybridJ  with name "HybridJ": unscaled version of the
      previous algorithm
      • 
-         
    • ROOT::Math::GSLMultiRootFinder::kNewton  with name "Newton": Newton method 
      • 
-         
    • ROOT::Math::GSLMultiRootFinder::kGNewton  with name "GNewton": modified Newton method 
      • 
+         
    • ROOT::Math::GSLMultiRootFinder::kNewton  with name "Newton": Newton method 
      • 
+         
    • ROOT::Math::GSLMultiRootFinder::kGNewton  with name "GNewton": modified Newton method 
      • 
      
    
      The algorithms without derivatives (see also the GSL
      documentation )
      are the followings:
      
      
-         
    • ROOT::Math::GSLMultiRootFinder::kHybridS  with name "HybridS": same as HybridSJ but using
+         
    • ROOT::Math::GSLMultiRootFinder::kHybridS  with name "HybridS": same as HybridSJ but using
      finate difference approximation for the derivatives
      • 
-         
    • ROOT::Math::GSLMultiRootFinder::kHybrid  with name "Hybrid": unscaled version of the
+         
    • ROOT::Math::GSLMultiRootFinder::kHybrid  with name "Hybrid": unscaled version of the
      previous algorithm
      • 
-         
    • ROOT::Math::GSLMultiRootFinder::kDNewton  with name "DNewton": discrete Newton algorithm 
      • 
-         
    • ROOT::Math::GSLMultiRootFinder::kBroyden  with name "Broyden": Broyden algorithm 
      • 
+         
    • ROOT::Math::GSLMultiRootFinder::kDNewton  with name "DNewton": discrete Newton algorithm 
      • 
+         
    • ROOT::Math::GSLMultiRootFinder::kBroyden  with name "Broyden": Broyden algorithm 
      • 
      
    
 
      @ingroup MultiRoot
diff --git a/math/matrix/doc/Matrix.md b/math/matrix/doc/Matrix.md
index f53b29ca0b..c484c27c72 100644
--- a/math/matrix/doc/Matrix.md
+++ b/math/matrix/doc/Matrix.md
@@ -325,7 +325,7 @@ constructor
       C=A*B
    
 A*=B
    
 C.Mult(A,B)
    TMatrixD(A,TMatrixD::kMult,B)
    TMatrixD(A, TMatrixD(A, TMatrixD::kTransposeMult,B)
    TMatrixD(A, TMatrixD::kMultTranspose,B)
-      overwrites A
     
     
    constructor of A.B
    constructor of AT .B
    constructor of A.BT
+      overwrites A
     
     
    constructor of A·B
    constructor of AT·B
    constructor of A·BT
     
       
       Element wise multiplication
diff --git a/math/minuit/src/TMinuit.cxx b/math/minuit/src/TMinuit.cxx
index df3e563a73..18a6437c68 100644
--- a/math/minuit/src/TMinuit.cxx
+++ b/math/minuit/src/TMinuit.cxx
@@ -187,11 +187,11 @@ the error matrix, or setting of exact confidence levels see:
 
   1. F.James.
      Determining the statistical Significance of experimental Results.
-     Technical Report DD/81/02 and CERN Report 81-03, CERN, 1981.
    • + Technical Report DD/81/02 and CERN Report 81-03, CERN, 1981. 2. W.T.Eadie, D.Drijard, F.James, M.Roos, and B.Sadoulet. Statistical Methods in Experimental Physics. - North-Holland, 1971. + North-Holland, 1971. ### Reliability of MINUIT error estimates. diff --git a/montecarlo/eg/src/TDatabasePDG.cxx b/montecarlo/eg/src/TDatabasePDG.cxx index 23c32e9668..85e9fe2a6d 100644 --- a/montecarlo/eg/src/TDatabasePDG.cxx +++ b/montecarlo/eg/src/TDatabasePDG.cxx @@ -46,7 +46,7 @@ Root.DatabasePDG: $(HOME)/my_pdg_table.txt See TParticlePDG for the description of a static particle properties. See TParticle for the description of a dynamic particle particle. -
    The current default pdg_table file displays lifetime 0 for some unstable particles.
    +The current default pdg_table file displays lifetime 0 for some unstable particles. */ diff --git a/montecarlo/vmc/README.md b/montecarlo/vmc/README.md index dc66ec401f..c731b26e92 100644 --- a/montecarlo/vmc/README.md +++ b/montecarlo/vmc/README.md @@ -43,7 +43,7 @@ See more detailed description in [the dedicated README](README.multiple.md). ## Authors The concept of Virtual MonteCarlo has been developed by the [ALICE Software Project](http://aliceinfo.cern.ch/Offline/).
    -Authors: R.Brun1, F.Carminati1, A. Gheata1, I.Hrivnacova2, A.Morsch1, B.Volkel1;
    +Authors: R. Brun1, F. Carminati1, A. Gheata1, I. Hrivnacova2, A. Morsch1, B. Volkel1;
    1European Organization for Nuclear Research (CERN), Geneva, Switzerland;
    2Institut de Physique Nucléaire dʼOrsay (IPNO), Université Paris-Sud, CNRS-IN2P3, Orsay, France diff --git a/net/http/civetweb/LICENSE.md b/net/http/civetweb/LICENSE.md index ab049e3e72..b6bb8ff037 100644 --- a/net/http/civetweb/LICENSE.md +++ b/net/http/civetweb/LICENSE.md @@ -180,10 +180,6 @@ Duktape License https://github.com/svaarala/duktape/blob/master/LICENSE.txt -> =============== -> Duktape license -> =============== -> > (http://opensource.org/licenses/MIT) > > Copyright (c) 2013-2017 by Duktape authors (see AUTHORS.rst) diff --git a/proof/proof/src/TProofMgr.cxx b/proof/proof/src/TProofMgr.cxx index 2a140e4e7a..e41b637a15 100644 --- a/proof/proof/src/TProofMgr.cxx +++ b/proof/proof/src/TProofMgr.cxx @@ -775,26 +775,29 @@ void TProofMgr::ReplaceSubdirs(const char *fn, TString &fdst, TList &dirph) /// Upload files provided via the list 'src' (as TFileInfo or TObjString) /// to 'mss'. The path under 'mss' is determined by 'dest'; the following /// place-holders can be used in 'dest': -/// , , , ... referring to the n-th sub-component -/// of the src path -/// basename in the source path -/// basename sans extension -/// Extension -/// serial number of file in the list -/// as but zero padded -/// the full file path -/// , the local user and group names. -/// the users PROOF group -/// immediate parent directory -/// next-to immediate parent directory +/// +/// Place-holder | Meaning | +/// ----------------------------|------------------------------------ +/// \, \, \, ... | referring to the n-th sub-component of the src path +/// \ | basename in the source path +/// \ | basename sans extension +/// \ | Extension +/// \ | serial number of file in the list +/// \ | as \ but zero padded +/// \ | the full file path +/// \, \ | the local user and group names. +/// \ | the users PROOF group +/// \ | immediate parent directory +/// \ | next-to immediate parent directory +/// /// So, for example, if the source filename for the 99-th file is /// protosrc://host//d0/d1/d2/d3/d4/d5/myfile -/// then with dest = '/pool/user/////' and +/// then with dest = '/pool/user/\/\/\/\/\' and /// mss = 'protodst://hostdst//nm/ /// the corresponding destination path is /// protodst://hostdst//nm/pool/user/d3/d4/d5/99/myfile /// -/// If 'dest' is empty, is used. +/// If 'dest' is empty, \ is used. /// /// Returns a TFileCollection with the destination files created; this /// TFileCollection is, for example, ready to be registered as dataset. @@ -966,20 +969,23 @@ TFileCollection *TProofMgr::UploadFiles(TList *src, /// line, with line beginning by '#' ignored (i.e. considered comments). /// The path under 'mss' is defined by 'dest'; the following /// place-holders can be used in 'dest': -/// , , , ... referring to the n-th sub-component -/// of the src path -/// basename in the source path -/// serial number of file in the list -/// the full file path -/// , the local user and group names. +/// +/// Place-holder | Meaning | +/// ----------------------------|------------------------------------ +/// \, \, \, ... | referring to the n-th sub-component of the src path +/// \ | basename in the source path +/// \ | serial number of file in the list +/// \ | the full file path +/// \, \ | the local user and group names. +/// /// So, for example, if the source filename for the 99-th file is /// protosrc://host//d0/d1/d2/d3/d4/d5/myfile -/// then with dest = '/pool/user/////' and +/// then with dest = '/pool/user/\/\/\/\/\' and /// mss = 'protodst://hostdst//nm/ /// the corresponding destination path is /// protodst://hostdst//nm/pool/user/d3/d4/d5/99/myfile /// -/// If 'dest' is empty, is used. +/// If 'dest' is empty, \ is used. /// /// Returns a TFileCollection with the destination files created; this /// TFileCollection is, for example, ready to be registered as dataset. diff --git a/proof/proof/src/TProofServ.cxx b/proof/proof/src/TProofServ.cxx index 24c521743d..3697f257a0 100644 --- a/proof/proof/src/TProofServ.cxx +++ b/proof/proof/src/TProofServ.cxx @@ -6696,11 +6696,11 @@ Int_t TProofServ::Fork() } //////////////////////////////////////////////////////////////////////////////// -/// Replace , , , , , , , and -/// placeholders in fname. -/// Here, is the root version in integer form, e.g. 53403, and a -/// string includign version, architecture and compiler version, e.g. -/// '53403_linuxx8664gcc_gcc46' . +/// Replace \, \, \, \, \, \, \, +/// \ and \ placeholders in fname. +/// Here, \ is the root version in integer form, e.g. 53403, and +/// \ a string includign version, architecture and compiler version, +/// e.g. '53403_linuxx8664gcc_gcc46' . void TProofServ::ResolveKeywords(TString &fname, const char *path) { diff --git a/roofit/histfactory/doc/index.md b/roofit/histfactory/doc/index.md index 32f1c551a4..9256a9cf11 100644 --- a/roofit/histfactory/doc/index.md +++ b/roofit/histfactory/doc/index.md @@ -41,12 +41,11 @@ it is organized as follows (see the examples in `${ROOTSYS}/tutorials/histfactor
  • several 'Measurements' (corresponding to a full fit of the model) each of which specifies
    • a name for this fit to be used in tables and files
      • -
        -
      • what is the luminosity associated to the measurement in picobarns
        • -
      • which bins of the histogram should be used
        • -
      • what is the relative uncertainty on the luminosity
        • -
      • what is (are) the parameter(s) of interest that will be measured
        • -
      • which parameters should be fixed/floating (eg. nuisance parameters)
        • +
      • what is the luminosity associated to the measurement in picobarns
        • +
      • which bins of the histogram should be used
        • +
      • what is the relative uncertainty on the luminosity
        • +
      • what is (are) the parameter(s) of interest that will be measured
        • +
      • which parameters should be fixed/floating (eg. nuisance parameters)
    diff --git a/roofit/histfactory/src/MakeModelAndMeasurementsFast.cxx b/roofit/histfactory/src/MakeModelAndMeasurementsFast.cxx index e14e63ec89..73a3f627ba 100644 --- a/roofit/histfactory/src/MakeModelAndMeasurementsFast.cxx +++ b/roofit/histfactory/src/MakeModelAndMeasurementsFast.cxx @@ -92,12 +92,11 @@ using namespace RooFit;
  • several 'Measurements' (corresponding to a full fit of the model) each of which specifies
    • a name for this fit to be used in tables and files
      • -
        -
      • what is the luminosity associated to the measurement in picobarns
        • -
      • which bins of the histogram should be used
        • -
      • what is the relative uncertainty on the luminosity
        • -
      • what is (are) the parameter(s) of interest that will be measured
        • -
      • which parameters should be fixed/floating (eg. nuisance parameters)
        • +
      • what is the luminosity associated to the measurement in picobarns
        • +
      • which bins of the histogram should be used
        • +
      • what is the relative uncertainty on the luminosity
        • +
      • what is (are) the parameter(s) of interest that will be measured
        • +
      • which parameters should be fixed/floating (eg. nuisance parameters)
    diff --git a/roofit/roofitcore/inc/RooAbsCategory.h b/roofit/roofitcore/inc/RooAbsCategory.h index a7eaf8772a..4f0937a99d 100644 --- a/roofit/roofitcore/inc/RooAbsCategory.h +++ b/roofit/roofitcore/inc/RooAbsCategory.h @@ -199,7 +199,7 @@ protected: return hasIndex(_currentIndex); } - /// If a category depends on the shape of others, *i.e.*, its state numbers or names depend + /// If a category depends on the shape of others, i.e.\ its state numbers or names depend /// on the states of other categories, this function has to be implemented to recompute /// _stateNames and _insertionOrder. /// If one of these two changes, setShapeDirty() has to be called to propagate this information diff --git a/roofit/roofitcore/src/RooSimPdfBuilder.cxx b/roofit/roofitcore/src/RooSimPdfBuilder.cxx index 4c8289523d..57ea1e9196 100644 --- a/roofit/roofitcore/src/RooSimPdfBuilder.cxx +++ b/roofit/roofitcore/src/RooSimPdfBuilder.cxx @@ -99,7 +99,7 @@ /// PDF for each state of the C index category. ///

    ///     diff --git a/tmva/tmva/src/Factory.cxx b/tmva/tmva/src/Factory.cxx index eda1b9ca1a..866aad0e18 100644 --- a/tmva/tmva/src/Factory.cxx +++ b/tmva/tmva/src/Factory.cxx @@ -683,9 +683,9 @@ void TMVA::Factory::WriteDataInformation(DataSetInfo& fDataSetInfo) } //////////////////////////////////////////////////////////////////////////////// -/// Iterates through all booked methods and sees if they use parameter tuning and if so.. -/// does just that i.e. calls "Method::Train()" for different parameter settings and -/// keeps in mind the "optimal one"... and that's the one that will later on be used +/// Iterates through all booked methods and sees if they use parameter tuning and if so +/// does just that, i.e.\ calls "Method::Train()" for different parameter settings and +/// keeps in mind the "optimal one"...\ and that's the one that will later on be used /// in the main training loop. std::map TMVA::Factory::OptimizeAllMethods(TString fomType, TString fitType) diff --git a/tmva/tmva/src/Reader.cxx b/tmva/tmva/src/Reader.cxx index 56d65bb9bf..b34ee9f1de 100644 --- a/tmva/tmva/src/Reader.cxx +++ b/tmva/tmva/src/Reader.cxx @@ -594,7 +594,7 @@ const std::vector< Float_t >& TMVA::Reader::EvaluateRegression( const TString& m //////////////////////////////////////////////////////////////////////////////// /// evaluates the regression MVA /// check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence -/// it is not again checked in each of these subsequent calls.. +/// it is not again checked in each of these subsequent calls. const std::vector< Float_t >& TMVA::Reader::EvaluateRegression( MethodBase* method, Double_t /*aux*/ ) { @@ -660,7 +660,7 @@ const std::vector< Float_t >& TMVA::Reader::EvaluateMulticlass( const TString& m //////////////////////////////////////////////////////////////////////////////// /// evaluates the multiclass MVA /// check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence -/// it is not again checked in each of these subsequent calls.. +/// it is not again checked in each of these subsequent calls. const std::vector< Float_t >& TMVA::Reader::EvaluateMulticlass( MethodBase* method, Double_t /*aux*/ ) { diff --git a/tree/dataframe/inc/ROOT/RDF/RColumnValue.hxx b/tree/dataframe/inc/ROOT/RDF/RColumnValue.hxx index 17527ac16d..497dd3d5c6 100644 --- a/tree/dataframe/inc/ROOT/RDF/RColumnValue.hxx +++ b/tree/dataframe/inc/ROOT/RDF/RColumnValue.hxx @@ -93,7 +93,7 @@ class R__CLING_PTRCHECK(off) RColumnValue { /// Enumerator for the different properties of the branch storage in memory enum class EStorageType : char { kContiguous, kUnknown, kSparse }; /// Signal whether we ever checked that the branch we are reading with a TTreeReaderArray stores array elements - /// in contiguous memory. Only used when T == RVec. + /// in contiguous memory. Only used when T == RVec\. EStorageType fStorageType = EStorageType::kUnknown; /// If MustUseRVec, i.e. we are reading an array, we return a reference to this RVec to clients RVec fRVec; diff --git a/tutorials/net/udpserver.c b/tutorials/net/udpserver.c index c54685400e..a74f6f0a85 100644 --- a/tutorials/net/udpserver.c +++ b/tutorials/net/udpserver.c @@ -4,7 +4,7 @@ /* Converted to echo client/server with select() (timeout option). See testTUDPSocket.C */ -/* Compile with: gcc udpserver.c -o udpserver +/* Compile with: gcc udpserver.c -o udpserver */ /* on Windows: cl -nologo -Z7 -MD -GR -EHsc udpserver.c */ /* 3/30/05 John Schultz */ diff --git a/tutorials/tmva/TMVA_CNN_Classification.C b/tutorials/tmva/TMVA_CNN_Classification.C index 47f26368d9..89373a8887 100644 --- a/tutorials/tmva/TMVA_CNN_Classification.C +++ b/tutorials/tmva/TMVA_CNN_Classification.C @@ -22,7 +22,7 @@ /// Helper function to create input images data /// we create a signal and background 2D histograms from 2d gaussians /// with a location (means in X and Y) different for each event -/// The difference between signal and background is in the gaussian width.. +/// The difference between signal and background is in the gaussian width. /// The width for the bakground gaussian is slightly larger than the signal width by few % values /// /// -- 2.26.2

    -/// In the above example RooSimPdfBuilder +/// In the above example RooSimPdfBuilder /// will first replicate k and s into /// k_C1,k_C2 and s_C1,s_C2, as prescribed in the /// configuration. Then it will recursively replicate all PDF nodes that depend on @@ -383,7 +383,7 @@ /// pdfA(x;p,q) and pdfB(x;p,r) that have a common parameter p. /// We want to build a RooSimultaneous for both pdfA and B, /// which involves a split of parameter p and we would like to build the -/// simultaneous pdfs simA and simB such that still share their (now split) parameters +/// simultaneous pdfs simA and simB such that still share their (now split) parameters /// p_XXX. This is accomplished by letting a single instance of RooSimPdfBuilder handle /// the builds of both pdfA and pdfB, as illustrated in this example: ///