|
|
b2cd752 |
From 7336caccd3288a9164c82b78053e8f4f59eb1a9c Mon Sep 17 00:00:00 2001
|
|
|
b2cd752 |
From: Mattias Ellert <mattias.ellert@physics.uu.se>
|
|
|
b2cd752 |
Date: Sun, 12 Jul 2020 12:12:15 +0200
|
|
|
b2cd752 |
Subject: [PATCH] Remove /** comments */ from md files
|
|
|
b2cd752 |
|
|
|
b2cd752 |
---
|
|
|
b2cd752 |
math/genvector/doc/Genvector.md | 7 -------
|
|
|
b2cd752 |
math/genvector/doc/LorentzVector.md | 6 +-----
|
|
|
b2cd752 |
math/genvector/doc/Point3D.md | 6 ------
|
|
|
b2cd752 |
math/genvector/doc/Transformation.md | 6 ------
|
|
|
b2cd752 |
math/genvector/doc/Vector3D.md | 4 ----
|
|
|
b2cd752 |
math/genvector/doc/VectorPoint2D.md | 6 ------
|
|
|
b2cd752 |
math/genvector/doc/externalUsage.md | 6 ------
|
|
|
b2cd752 |
math/mathcore/doc/MathCore.md | 5 -----
|
|
|
b2cd752 |
math/mathmore/doc/MathMore.md | 5 -----
|
|
|
b2cd752 |
math/matrix/doc/Matrix.md | 3 ---
|
|
|
b2cd752 |
math/unuran/doc/Unuran.md | 8 ++------
|
|
|
b2cd752 |
11 files changed, 3 insertions(+), 59 deletions(-)
|
|
|
b2cd752 |
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/Genvector.md b/math/genvector/doc/Genvector.md
|
|
|
b2cd752 |
index 12e4e47a93..50dc61b2ce 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/Genvector.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/Genvector.md
|
|
|
b2cd752 |
@@ -1,5 +1,3 @@
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page Vector Generic Vector for 2, 3 and 4 Dimensions
|
|
|
b2cd752 |
|
|
|
b2cd752 |
|
|
|
b2cd752 |
@@ -113,8 +111,3 @@ A more detailed description of all the GenVector classes is available in this [d
|
|
|
b2cd752 |
2. [CLHEP Geometry package](http://www.hep.phy.cam.ac.uk/lhcb/doc/CLHEP/1.9.1.2/html/namespaceH)
|
|
|
b2cd752 |
3. [%ROOT Physics Vector classes](http://root.cern.ch/root/html/PHYSICS_Index.html)
|
|
|
b2cd752 |
4. [CMS Vector package](http://lcgapp.cern.ch/doxygen/SEAL/snapshot/html/dir_000007.html)
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-* * *
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/LorentzVector.md b/math/genvector/doc/LorentzVector.md
|
|
|
b2cd752 |
index b40ea8c69c..e01ed4a8ca 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/LorentzVector.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/LorentzVector.md
|
|
|
b2cd752 |
@@ -1,6 +1,4 @@
|
|
|
b2cd752 |
-// LorentzVector doxygen page
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/** \page LorentzVectorPage LorentzVector Classes
|
|
|
b2cd752 |
+\page LorentzVectorPage LorentzVector Classes
|
|
|
b2cd752 |
|
|
|
b2cd752 |
To avoid exposing templated parameter to the users, typedefs are defined for all types of vectors based an double's and float's. To use them, one must include the header file _Math/Vector4D.h_. The following typedef's, defined in the header file _Math/Vector4Dfwd.h_, are available for the different instantiations of the template class ROOT::Math::LorentzVector:
|
|
|
b2cd752 |
|
|
|
b2cd752 |
@@ -110,5 +108,3 @@ v.Beta(); // return beta and gamma value
|
|
|
b2cd752 |
v.Gamma() // (vector must be time-like otherwise result is meaningless)
|
|
|
b2cd752 |
XYZVector b = v.BoostToCM() // return boost vector which will bring the Vector in its mas frame (P=0)
|
|
|
b2cd752 |
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/Point3D.md b/math/genvector/doc/Point3D.md
|
|
|
b2cd752 |
index a273b182d4..db55c68752 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/Point3D.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/Point3D.md
|
|
|
b2cd752 |
@@ -1,7 +1,3 @@
|
|
|
b2cd752 |
-// Point3d doxygen page
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page Point3DPage Point3D Classes
|
|
|
b2cd752 |
|
|
|
b2cd752 |
To avoid exposing templated parameter to the users, typedefs are defined for all types of vectors based an double's and float's. To use them, one must include the header file _Math/Point3D.h_. The following typedef's, defined in the header file _Math/Point3Dfwd.h_, are available for the different instantiations of the template class ROOT::Math::PositionVector3D:
|
|
|
b2cd752 |
@@ -61,5 +57,3 @@ Exactly as for the 3D Vectors, the following operations are allowed:
|
|
|
b2cd752 |
* comparison of points
|
|
|
b2cd752 |
* scaling and division of points with a scalar
|
|
|
b2cd752 |
* dot and cross product with any type of vector
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/Transformation.md b/math/genvector/doc/Transformation.md
|
|
|
b2cd752 |
index 7e66107f55..edc36778ed 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/Transformation.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/Transformation.md
|
|
|
b2cd752 |
@@ -1,7 +1,3 @@
|
|
|
b2cd752 |
-// Rotation and transformation doxygen page
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page TransformPage Vector Transformations
|
|
|
b2cd752 |
|
|
|
b2cd752 |
Transformations classes are grouped in Rotations (in 3 dimensions), Lorentz transformations and Poincarre transformations, which are Translation/Rotation combinations. Each group has several members which may model physically equivalent trasformations but with different internal representations.
|
|
|
b2cd752 |
@@ -114,5 +110,3 @@ Transform3D t; t.GetComponens(m); // fill matrix of size 3x4 with c
|
|
|
b2cd752 |
|
|
|
b2cd752 |
|
|
|
b2cd752 |
For more detailed documentation on all methods see the reference doc for the specific transformation class.
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/Vector3D.md b/math/genvector/doc/Vector3D.md
|
|
|
b2cd752 |
index 4f65f6b603..9d10ce7db2 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/Vector3D.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/Vector3D.md
|
|
|
b2cd752 |
@@ -1,5 +1,3 @@
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page Vector3DPage Vector3D Classes
|
|
|
b2cd752 |
|
|
|
b2cd752 |
|
|
|
b2cd752 |
@@ -120,5 +118,3 @@ Note that the multiplication between two vectors using the operator * is not sup
|
|
|
b2cd752 |
|
|
|
b2cd752 |
XYZVector u = v1.Unit(); // return unit vector parallel to v1
|
|
|
b2cd752 |
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/VectorPoint2D.md b/math/genvector/doc/VectorPoint2D.md
|
|
|
b2cd752 |
index 5c5e665088..287f3f8b73 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/VectorPoint2D.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/VectorPoint2D.md
|
|
|
b2cd752 |
@@ -1,7 +1,3 @@
|
|
|
b2cd752 |
-// Vector2d doxygen page
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page Vector2DPage 2D Point and Vector Classes
|
|
|
b2cd752 |
|
|
|
b2cd752 |
Similar to the \ref Vector3DPage and \ref Point3DPage , typedefs are defined to avoid exposing templated parameter to the users, for all 2D vectors based an double's and float's. To use them, one must include the header file _Math/Vector2D.h_ or _Math/Point2D.h_. The following typedef's, defined in the header file _Math/Vector2Dfwd.h_, are available for the different instantiations of the template class ROOT::Math::DisplacementVector2D:
|
|
|
b2cd752 |
@@ -19,5 +15,3 @@ The typedef's, defined in the header file _Math/Point2Dfwd.h_, available for the
|
|
|
b2cd752 |
* ROOT::Math::Polar2DPointF vector based on r,phi coordinates (polar) in float precision
|
|
|
b2cd752 |
|
|
|
b2cd752 |
Similar constructs, functions and operations available for the 3D vectors and points (see \ref Vector3DPage and \ref Point3DPage ) are available also for the 2D vector and points. No transformations or rotation classes are available for the 2D vectors.
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/genvector/doc/externalUsage.md b/math/genvector/doc/externalUsage.md
|
|
|
b2cd752 |
index f8580225a5..4413bbafca 100644
|
|
|
b2cd752 |
--- a/math/genvector/doc/externalUsage.md
|
|
|
b2cd752 |
+++ b/math/genvector/doc/externalUsage.md
|
|
|
b2cd752 |
@@ -1,7 +1,3 @@
|
|
|
b2cd752 |
-// example on using with exteral classes (doxygen page)
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page ExtUsagePage Examples with External Packages
|
|
|
b2cd752 |
|
|
|
b2cd752 |
### Connection to Linear Algebra classes
|
|
|
b2cd752 |
@@ -48,5 +44,3 @@ XYZPoint p1(hp); // create a 3D Point from CLHEP geom
|
|
|
b2cd752 |
|
|
|
b2cd752 |
CLHEP::HepLorentzVector hq;
|
|
|
b2cd752 |
XYZTVector q(hq); // create a LorentzVector from CLHEP L.V.</double>
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/mathcore/doc/MathCore.md b/math/mathcore/doc/MathCore.md
|
|
|
b2cd752 |
index 4efc043cab..8d38b4ae19 100644
|
|
|
b2cd752 |
--- a/math/mathcore/doc/MathCore.md
|
|
|
b2cd752 |
+++ b/math/mathcore/doc/MathCore.md
|
|
|
b2cd752 |
@@ -1,5 +1,3 @@
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\defgroup MathCore MathCore
|
|
|
b2cd752 |
|
|
|
b2cd752 |
\brief The Core Mathematical Library of %ROOT. See the \ref MathCorePage "MathCore" description page.
|
|
|
b2cd752 |
@@ -32,6 +30,3 @@ MathCore contains instead now classes which were originally part of _libCore_. T
|
|
|
b2cd752 |
* Other classes, such as
|
|
|
b2cd752 |
* TKDTree for partitioning the data using a kd-Tree and TKDTreeBinning for binning data using a kdTree
|
|
|
b2cd752 |
* ROOT::Math::GoFTest for goodness of fit tests
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/mathmore/doc/MathMore.md b/math/mathmore/doc/MathMore.md
|
|
|
b2cd752 |
index 28b3528a68..f30ef6d0be 100644
|
|
|
b2cd752 |
--- a/math/mathmore/doc/MathMore.md
|
|
|
b2cd752 |
+++ b/math/mathmore/doc/MathMore.md
|
|
|
b2cd752 |
@@ -1,6 +1,3 @@
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\defgroup MathMore MathMore
|
|
|
b2cd752 |
|
|
|
b2cd752 |
\brief The Mathematical library providing some advanced functionality and based on GSL. See the \ref MathMorePage "MathMore" Library page.
|
|
|
b2cd752 |
@@ -32,5 +29,3 @@ To build MathMore you need to have first GSL installed somewhere in your system.
|
|
|
b2cd752 |
MathMore (and its %ROOT CINT dictionary) can be built within %ROOT whenever a GSL library is found in the system. Optionally the GSL library and header file location can be specified in the %ROOT configure script with _configure --with-gsl-incdir=... --with-gsl-libdir=..._
|
|
|
b2cd752 |
MathMore links with the GSL static libraries. On some platform (like Linux x86-64) GSL needs to be compiled with the option _--with-pic_.
|
|
|
b2cd752 |
The source code of MathMore is distributed under the GNU General Public License
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
diff --git a/math/matrix/doc/Matrix.md b/math/matrix/doc/Matrix.md
|
|
|
b2cd752 |
index ed0d9fffe8..f0b9d7a06a 100644
|
|
|
b2cd752 |
--- a/math/matrix/doc/Matrix.md
|
|
|
b2cd752 |
+++ b/math/matrix/doc/Matrix.md
|
|
|
b2cd752 |
@@ -1,6 +1,3 @@
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\page MatrixPage The ROOT Matrix Linear Algebra classes.
|
|
|
b2cd752 |
|
|
|
b2cd752 |
|
|
|
b2cd752 |
diff --git a/math/unuran/doc/Unuran.md b/math/unuran/doc/Unuran.md
|
|
|
b2cd752 |
index d807c4e807..4c64e0d214 100644
|
|
|
b2cd752 |
--- a/math/unuran/doc/Unuran.md
|
|
|
b2cd752 |
+++ b/math/unuran/doc/Unuran.md
|
|
|
b2cd752 |
@@ -1,9 +1,7 @@
|
|
|
b2cd752 |
-/**
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
-Universal Non Uniform Random number generator for generating non uniform pseudo-random numbers
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
\defgroup Unuran Unuran
|
|
|
b2cd752 |
|
|
|
b2cd752 |
+\brief Universal Non Uniform Random number generator for generating non uniform pseudo-random numbers.
|
|
|
b2cd752 |
+
|
|
|
b2cd752 |
\ingroup Math
|
|
|
b2cd752 |
|
|
|
b2cd752 |
UNU.RAN, (Universal Non Uniform Random number generator for generating non uniform pseudo-random numbers)
|
|
|
b2cd752 |
@@ -120,5 +118,3 @@ TRandom pointer when constructing the TUnuran class (by default the ROOT gRandom
|
|
|
b2cd752 |
|
|
|
b2cd752 |
The (UNU.RAN documentation)[http://statistik.wu-wien.ac.at/unuran/doc/unuran.html#Top] provides a detailed
|
|
|
b2cd752 |
description of all the available methods and the possible options which one can pass to UNU.RAN for the various distributions.
|
|
|
b2cd752 |
-*/
|
|
|
b2cd752 |
-
|
|
|
b2cd752 |
--
|
|
|
b2cd752 |
2.26.2
|
|
|
b2cd752 |
|