Simplify and correct Doxygen lists using '-' rather than '\li \c'

This commit is contained in:
Henry Weller
2016-06-16 20:10:39 +01:00
parent c2dcd18887
commit 9cfccd2093
22 changed files with 141 additions and 143 deletions

View File

@ -37,11 +37,10 @@ Description
\endverbatim
Types of coordinateRotation:
\li 1. axesRotation
\li 2. STARCDRotation
\li 3. cylindrical
\li 4. EulerCoordinateRotation
-# axesRotation
-# STARCDRotation
-# cylindrical
-# EulerCoordinateRotation
SourceFiles
coordinateRotation.C

View File

@ -26,21 +26,21 @@ Class
Description
A local coordinate rotation.
The cell based rotational field can be created in two ways:
-# Each rotational tensor is defined with two vectors (\c dir and \c e3)
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
Per each cell an axesRotation type of rotation is created
(cylindrical coordinates). For example:
\verbatim
cylindrical
{
type localAxes;
e3 (0 0 1);
}
\endverbatim
\li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
Per each cell an axesRotation type of rotation is created
(cylindrical coordinates). For example:
\verbatim
cylindrical
{
type localAxes;
e3 (0 0 1);
}
\endverbatim
\li 2. The rotational tensor field is provided at construction.
-# The rotational tensor field is provided at construction.
SourceFiles
cylindrical.C

View File

@ -43,15 +43,13 @@ Description
\endverbatim
Types of coordinateRotation:
\li 1. axesRotation
\li 2. STARCDRotation
\li 3. cylindrical
\li 4. EulerCoordinateRotation
-# axesRotation
-# \link STARCDCoordinateRotation STARCDRotation \endlink
-# cylindricalCS cylindrical
-# EulerCoordinateRotation
Type of co-ordinates:
\li 1. cartesian
-# \link cartesianCS cartesian \endlink
SourceFiles

View File

@ -25,20 +25,18 @@ Class
Foam::surfaceLocation
Description
Contains information about location on a triSurface:
Contains information about location on a triSurface
\li pointIndexHit:
Access to data:
- pointIndexHit provides
- location
- bool: hit/miss
- index (of triangle/point/edge)
\li elementType():
- elementType() provides
- what index above relates to. In triangle::proxType
\li triangle():
- triangle() provides
- last known triangle
SourceFiles
surfaceLocation.C