From d9241644f406079bcf7bdbf55b9298d20def03d1 Mon Sep 17 00:00:00 2001
From: Lorenzo Moneta <Lorenzo.Moneta@cern.ch>
Date: Tue, 18 Dec 2007 17:51:12 +0000
Subject: [PATCH] add tag for class description
git-svn-id: http://root.cern.ch/svn/root/trunk@21468 27541ba8-7e3a-0410-8455-c3a389f83636
---
mathcore/inc/Math/GenVector/AxisAngle.h | 15 +++++------
mathcore/inc/Math/GenVector/Boost.h | 3 ++-
.../inc/Math/GenVector/DisplacementVector2D.h | 25 ++++++++++---------
.../inc/Math/GenVector/DisplacementVector3D.h | 2 +-
mathcore/inc/Math/GenVector/EulerAngles.h | 21 ++++++++--------
mathcore/inc/Math/GenVector/LorentzRotation.h | 5 ++--
mathcore/inc/Math/GenVector/LorentzVector.h | 1 +
.../inc/Math/GenVector/PositionVector2D.h | 25 ++++++++++---------
.../inc/Math/GenVector/PositionVector3D.h | 1 +
mathcore/inc/Math/GenVector/Quaternion.h | 22 ++++++++--------
mathcore/inc/Math/GenVector/Rotation3D.h | 1 +
mathcore/inc/Math/GenVector/RotationZYX.h | 3 ++-
12 files changed, 68 insertions(+), 56 deletions(-)
diff --git a/mathcore/inc/Math/GenVector/AxisAngle.h b/mathcore/inc/Math/GenVector/AxisAngle.h
index b9ce19281c1..4a18abeccb1 100644
--- a/mathcore/inc/Math/GenVector/AxisAngle.h
+++ b/mathcore/inc/Math/GenVector/AxisAngle.h
@@ -30,13 +30,14 @@ namespace ROOT {
namespace Math {
- /**
- AxisAngle class describing a rotation as a direction axis and an
- angle of rotation around that axis.
-
- @ingroup GenVector
-
- */
+//__________________________________________________________________________________________
+ /**
+ AxisAngle class describing rotation represented with direction axis (3D Vector) and an
+ angle of rotation around that axis.
+
+ @ingroup GenVector
+
+ */
class AxisAngle {
public:
diff --git a/mathcore/inc/Math/GenVector/Boost.h b/mathcore/inc/Math/GenVector/Boost.h
index 5ea13d8bd75..d4b7a8f4701 100644
--- a/mathcore/inc/Math/GenVector/Boost.h
+++ b/mathcore/inc/Math/GenVector/Boost.h
@@ -30,6 +30,7 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Lorentz boost class with the (4D) transformation represented internally
by a 4x4 orthosymplectic matrix.
@@ -37,7 +38,7 @@ namespace ROOT {
specialized Lorentz boosts.
Also, the 3-D rotation classes can be considered to be special Lorentz
transformations which do not mix space and time components.
-
+
@ingroup GenVector
*/
diff --git a/mathcore/inc/Math/GenVector/DisplacementVector2D.h b/mathcore/inc/Math/GenVector/DisplacementVector2D.h
index 0d2c9285a5d..c916b1361d7 100644
--- a/mathcore/inc/Math/GenVector/DisplacementVector2D.h
+++ b/mathcore/inc/Math/GenVector/DisplacementVector2D.h
@@ -51,18 +51,19 @@ namespace ROOT {
- /**
- Class describing a generic displacement vector in 2 dimensions.
- This class is templated on the type of Coordinate system.
- One example is the XYVector which is a vector based on
- double precision x,y data members by using the
- Cartesian2D<double> Coordinate system.
- The class is having also an extra template parameter, the coordinate system tag,
- to be able to identify (tag) vector described in different reference coordinate system,
- like global or local coordinate systems.
-
- @ingroup GenVector
- */
+//__________________________________________________________________________________________
+ /**
+ Class describing a generic displacement vector in 2 dimensions.
+ This class is templated on the type of Coordinate system.
+ One example is the XYVector which is a vector based on
+ double precision x,y data members by using the
+ Cartesian2D<double> Coordinate system.
+ The class is having also an extra template parameter, the coordinate system tag,
+ to be able to identify (tag) vector described in different reference coordinate system,
+ like global or local coordinate systems.
+
+ @ingroup GenVector
+ */
template <class CoordSystem, class Tag = DefaultCoordinateSystemTag >
class DisplacementVector2D {
diff --git a/mathcore/inc/Math/GenVector/DisplacementVector3D.h b/mathcore/inc/Math/GenVector/DisplacementVector3D.h
index a0ed65a0eeb..6d84580ba42 100644
--- a/mathcore/inc/Math/GenVector/DisplacementVector3D.h
+++ b/mathcore/inc/Math/GenVector/DisplacementVector3D.h
@@ -57,7 +57,7 @@ namespace ROOT {
namespace Math {
-
+//__________________________________________________________________________________________
/**
Class describing a generic displacement vector in 3 dimensions.
This class is templated on the type of Coordinate system.
diff --git a/mathcore/inc/Math/GenVector/EulerAngles.h b/mathcore/inc/Math/GenVector/EulerAngles.h
index d4eefcc8f77..74233041386 100644
--- a/mathcore/inc/Math/GenVector/EulerAngles.h
+++ b/mathcore/inc/Math/GenVector/EulerAngles.h
@@ -29,16 +29,17 @@ namespace ROOT {
namespace Math {
- /**
- EulerAngles class describing rotation as three angles (Euler Angles).
- The Euler angles definition matches that of Classical Mechanics (Goldstein).
- It is also the same convention defined in
- <A HREF="http://mathworld.wolfram.com/EulerAngles.html">mathworld</A>
- and used in Mathematica and CLHEP. Note that the ROOT class TRotation defines
- a slightly different convention.
-
- @ingroup GenVector
- */
+//__________________________________________________________________________________________
+ /**
+ EulerAngles class describing rotation as three angles (Euler Angles).
+ The Euler angles definition matches that of Classical Mechanics (Goldstein).
+ It is also the same convention defined in
+ <A HREF="http://mathworld.wolfram.com/EulerAngles.html">mathworld</A>
+ and used in Mathematica and CLHEP. Note that the ROOT class TRotation defines
+ a slightly different convention.
+
+ @ingroup GenVector
+ */
class EulerAngles {
public:
diff --git a/mathcore/inc/Math/GenVector/LorentzRotation.h b/mathcore/inc/Math/GenVector/LorentzRotation.h
index 3917bf34dd2..1a7cc64b7de 100644
--- a/mathcore/inc/Math/GenVector/LorentzRotation.h
+++ b/mathcore/inc/Math/GenVector/LorentzRotation.h
@@ -38,6 +38,7 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Lorentz transformation class with the (4D) transformation represented by
a 4x4 orthosymplectic matrix.
@@ -45,9 +46,9 @@ namespace ROOT {
specialized Lorentz transformations.
Also, the 3-D rotation classes can be considered to be special Lorentz
transformations which do not mix space and time components.
-
+
@ingroup GenVector
-
+
*/
class LorentzRotation {
diff --git a/mathcore/inc/Math/GenVector/LorentzVector.h b/mathcore/inc/Math/GenVector/LorentzVector.h
index e26c889a7de..0d42fcf84e6 100644
--- a/mathcore/inc/Math/GenVector/LorentzVector.h
+++ b/mathcore/inc/Math/GenVector/LorentzVector.h
@@ -36,6 +36,7 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Class describing a generic LorentzVector in the 4D space-time,
using the specified coordinate system for the spatial vector part.
diff --git a/mathcore/inc/Math/GenVector/PositionVector2D.h b/mathcore/inc/Math/GenVector/PositionVector2D.h
index 316c781b071..419872832f2 100644
--- a/mathcore/inc/Math/GenVector/PositionVector2D.h
+++ b/mathcore/inc/Math/GenVector/PositionVector2D.h
@@ -39,18 +39,19 @@ namespace ROOT {
namespace Math {
- /**
- Class describing a generic position vector (point) in 2 dimensions.
- This class is templated on the type of Coordinate system.
- One example is the XYPoint which is a vector based on
- double precision x,y data members by using the
- Cartesian2D<double> Coordinate system.
- The class is having also an extra template parameter, the coordinate system tag,
- to be able to identify (tag) vector described in different reference coordinate system,
- like global or local coordinate systems.
-
- @ingroup GenVector
- */
+//__________________________________________________________________________________________
+ /**
+ Class describing a generic position vector (point) in 2 dimensions.
+ This class is templated on the type of Coordinate system.
+ One example is the XYPoint which is a vector based on
+ double precision x,y data members by using the
+ Cartesian2D<double> Coordinate system.
+ The class is having also an extra template parameter, the coordinate system tag,
+ to be able to identify (tag) vector described in different reference coordinate system,
+ like global or local coordinate systems.
+
+ @ingroup GenVector
+ */
template <class CoordSystem, class Tag = DefaultCoordinateSystemTag >
class PositionVector2D {
diff --git a/mathcore/inc/Math/GenVector/PositionVector3D.h b/mathcore/inc/Math/GenVector/PositionVector3D.h
index 18e3d42daf3..02d8360d3ad 100644
--- a/mathcore/inc/Math/GenVector/PositionVector3D.h
+++ b/mathcore/inc/Math/GenVector/PositionVector3D.h
@@ -45,6 +45,7 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Class describing a generic position vector (point) in 3 dimensions.
This class is templated on the type of Coordinate system.
diff --git a/mathcore/inc/Math/GenVector/Quaternion.h b/mathcore/inc/Math/GenVector/Quaternion.h
index b088a9c6ff9..652c46b959d 100644
--- a/mathcore/inc/Math/GenVector/Quaternion.h
+++ b/mathcore/inc/Math/GenVector/Quaternion.h
@@ -32,16 +32,18 @@ namespace ROOT {
namespace Math {
- /**
- Rotation class with the (3D) rotation represented by
- a unit quaternion (u, i, j, k).
- This is the optimal representation for multiplication of multiple
- rotations, and for computation of group-manifold-invariant distance
- between two rotations.
- See also AxisAngle, EulerAngles, and Rotation3D.
-
- @ingroup GenVector
- */
+//__________________________________________________________________________________________
+ /**
+ Rotation class with the (3D) rotation represented by
+ a unit quaternion (u, i, j, k).
+ This is the optimal representation for multiplication of multiple
+ rotations, and for computation of group-manifold-invariant distance
+ between two rotations.
+ See also AxisAngle, EulerAngles, and Rotation3D.
+
+ @ingroup GenVector
+ */
+
class Quaternion {
public:
diff --git a/mathcore/inc/Math/GenVector/Rotation3D.h b/mathcore/inc/Math/GenVector/Rotation3D.h
index 9602479cb70..1f6f342b1dd 100644
--- a/mathcore/inc/Math/GenVector/Rotation3D.h
+++ b/mathcore/inc/Math/GenVector/Rotation3D.h
@@ -44,6 +44,7 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Rotation class with the (3D) rotation represented by
a 3x3 orthogonal matrix.
diff --git a/mathcore/inc/Math/GenVector/RotationZYX.h b/mathcore/inc/Math/GenVector/RotationZYX.h
index 9973bea89eb..ca32b3fb4ff 100644
--- a/mathcore/inc/Math/GenVector/RotationZYX.h
+++ b/mathcore/inc/Math/GenVector/RotationZYX.h
@@ -53,12 +53,13 @@ namespace ROOT {
namespace Math {
+//__________________________________________________________________________________________
/**
Rotation class with the (3D) rotation represented by
angles describing first a rotation of
an angle phi (yaw) about the Z axis,
followed by a rotation of an angle theta (pitch) about the new Y' axis,
- folowed by a third rotation of an angle psi (roll) about the final X'' axis.
+ followed by a third rotation of an angle psi (roll) about the final X'' axis.
This is sometimes referred to as the Euler 321 sequence.
It has not to be confused with the typical Goldstein definition of the Euler Angles
(Z-X-Z or 313 sequence) which is used by the ROOT::Math::EulerAngles class.
--
GitLab