Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs

applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -30,7 +30,7 @@ Description
     corresponding to PDR basic drag model (\link basic.H \endlink)
 
     The default model coefficients correspond to the following:
-    @verbatim
+    \verbatim
         PDRkEpsilonCoeffs
         {
             Cmu         0.09;
@@ -41,7 +41,7 @@ Description
             sigmaEps    1.3;
             Prt         1.0;    // only for compressible
         }
-    @endverbatim
+    \endverbatim
 
     The turbulence source term \f$ G_{R} \f$ appears in the
     \f$ \kappa-\epsilon \f$ equation for the generation of turbulence due to

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEBlendXiEq/SCOPEBlendXiEq.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -27,7 +27,7 @@ Class
 Description
     Simple SCOPEBlendXiEq model for XiEq based on SCOPEXiEqs correlation
     with a linear correction function to give a plausible profile for XiEq.
-    See @link SCOPELaminarFlameSpeed.H @endlink for details on the SCOPE
+    See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE
     laminar flame speed model.
 
 SourceFiles

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/instabilityXiEq/instabilityXiEq.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -27,7 +27,7 @@ Class
 Description
     This is the equilibrium level of the flame wrinkling generated by
     instability. It is a constant (default 2.5). It is used in
-    @link XiModel.H @endlink.
+    \link XiModel.H \endlink.
 
 SourceFiles
     instability.C

applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -30,7 +30,7 @@ Description
     causing pressure loss as estimated using an adjoint formulation.
 
     References:
-    @verbatim
+    \verbatim
         "Implementation of a continuous adjoint for topology optimization of
          ducted flows"
         C. Othmer,
@@ -38,7 +38,7 @@ Description
         H.G. Weller
         AIAA-2007-3947
         http://pdf.aiaa.org/preview/CDReadyMCFD07_1379/PV2007_3947.pdf
-    @endverbatim
+    \endverbatim
 
     Note that this solver optimises for total pressure loss whereas the
     above paper describes the method for optimising power-loss.

applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H

@@ -32,14 +32,14 @@ Description
     implicit term in the pressure equation.
 
     Reference:
-    @verbatim
+    \verbatim
         Kunz, R.F., Boger, D.A., Stinebring, D.R., Chyczewski, Lindau. J.W.,
         Gibeling, H.J., Venkateswaran, S., Govindan, T.R.,
         “A Preconditioned Implicit Method for Two-Phase Flows with Application
          to Cavitation Prediction,”
         Computers and Fluids,
         29(8):849-875, 2000.
-    @endverbatim
+    \endverbatim
 
 SourceFiles
     Kunz.C

applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H

@@ -28,12 +28,12 @@ Description
     Merkle cavitation model.
 
     Reference:
-    @verbatim
+    \verbatim
         C. L. Merkle, J. Feng, and P. E. O. Buelow,
         "Computational modeling of the dynamics of sheet cavitation",
         in Proceedings Third International Symposium on Cavitation
         Grenoble, France 1998.
-   @endverbatim
+   \endverbatim
 
 SourceFiles
     Merkle.C

applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H

@@ -28,12 +28,12 @@ Description
     SchnerrSauer cavitation model.
 
     Reference:
-    @verbatim
+    \verbatim
         Schnerr, G. H., And Sauer, J.,
         "Physical and Numerical Modeling of Unsteady Cavitation Dynamics",
         Proc. 4th International Conference on Multiphase Flow,
         New Orleans, U.S.A., 2001.
-    @endverbatim
+    \endverbatim
 
 SourceFiles
     SchnerrSauer.C

applications/test/Distribution/Test-Distribution.C

@@ -29,12 +29,12 @@ Description
 
     Plot normal distribution test in gnuplot using:
 
-    @verbatim
+    \verbatim
     normalDistribution(mean, sigma, x) = \
         sqrt(1.0/(2.0*pi*sigma**2))*exp(-(x - mean)**2.0/(2.0*sigma**2))
 
     plot normalDistribution(8.5, 2.5, x), "Distribution_scalar_test_x" w p
-    @endverbatim
+    \endverbatim
 
 \*---------------------------------------------------------------------------*/
 

applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -31,16 +31,16 @@ Usage
     - foamToStarMesh [OPTION] \n
     Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
 
-    @param -noBnd \n
-    Suppress writing the @c .bnd file
+    \param -noBnd \n
+    Suppress writing the \c .bnd file
 
-    @param -scale \<factor\>\n
+    \param -scale \<factor\>\n
     Specify an alternative geometry scaling factor.
-    The default is @b 1000 (scale @em [m] to @em [mm]).
+    The default is \b 1000 (scale \em [m] to \em [mm]).
 
 Note
     The cellTable information available in the files
-    @c constant/cellTable and @c constant/polyMesh/cellTableId
+    \c constant/cellTable and @c constant/polyMesh/cellTableId
     will be used if available. Otherwise the cellZones are used when
     creating the cellTable information.
 

applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2010-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -31,11 +31,11 @@ Usage
     - foamToSurface [OPTION] \n
     Reads an OpenFOAM mesh and writes the boundaries in a surface format.
 
-    @param -scale \<factor\>\n
+    \param -scale \<factor\>\n
     Specify an alternative geometry scaling factor.
-    Eg, use @b 1000 to scale @em [m] to @em [mm].
+    Eg, use \b 1000 to scale \em [m] to \em [mm].
 
-    @param -tri \n
+    \param -tri \n
     Triangulate surface.
 
 \*---------------------------------------------------------------------------*/

applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -27,7 +27,7 @@ Description
     Work in progress! Handles ascii multiblock (and optionally singleBlock)
     format.
     By default expects blanking. Use -noBlank if none.
-    Use -2D @a thickness if 2D.
+    Use -2D \a thickness if 2D.
 
     Niklas Nordin has experienced a problem with lefthandedness of the blocks.
     The code should detect this automatically - see hexBlock::readPoints but

applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -31,14 +31,14 @@ Usage
     - star4ToFoam [OPTION] ccmMesh\n
       convert pro-STAR mesh to OpenFOAM
 
-    @param -ascii \n
+    \param -ascii \n
     Write in ASCII format instead of binary
 
-    @param -scale \<factor\>\n
+    \param -scale \<factor\>\n
     Specify an alternative geometry scaling factor.
-    The default is @b 0.001 (scale @em [mm] to @em [m]).
+    The default is \b 0.001 (scale \em [mm] to \em [m]).
 
-    @param -solids \n
+    \param -solids \n
     Treat any solid cells present just like fluid cells.
     The default is to discard them.
 

applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -29,7 +29,7 @@ Description
     and run tetgen with -f option.
 
     Sample smesh file:
-    @verbatim
+    \verbatim
         # cube.smesh -- A 10x10x10 cube
         8 3
         1       0 0 0
@@ -49,7 +49,7 @@ Description
         4       2 6 7 3 65
         0
         0
-    @endverbatim
+    \endverbatim
 
 Note
     - for some reason boundary faces point inwards. I just reverse them

applications/utilities/mesh/generation/blockMesh/blockMeshApp.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -28,20 +28,20 @@ Description
     A multi-block mesh generator.
 
     Uses the block mesh description found in
-    @a constant/polyMesh/blockMeshDict
-    (or @a constant/\<region\>/polyMesh/blockMeshDict).
+    \a constant/polyMesh/blockMeshDict
+    (or \a constant/\<region\>/polyMesh/blockMeshDict).
 
 Usage
 
     - blockMesh [OPTION]
 
-    @param -blockTopology \n
+    \param -blockTopology \n
     Write the topology as a set of edges in OBJ format.
 
-    @param -region \<name\> \n
+    \param -region \<name\> \n
     Specify an alternative mesh region.
 
-    @param -dict \<filename\> \n
+    \param -dict \<filename\> \n
     Specify alternative dictionary for the block mesh description.
 
 \*---------------------------------------------------------------------------*/

applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C

@@ -108,13 +108,13 @@ Usage
 
     - extrudeToRegionMesh \<regionName\> \<faceZones\> \<thickness\>
 
-    @param \<regionName\> \n
+    \param \<regionName\> \n
     Name of mesh to create.
 
-    @param \<faceZones\> \n
+    \param \<faceZones\> \n
     List of faceZones to extrude
 
-    @param \<thickness\> \n
+    \param \<thickness\> \n
     Thickness of extruded mesh.
 
 \*---------------------------------------------------------------------------*/

applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/patchPointEdgeCirculator.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2010-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -28,7 +28,7 @@ Description
     Walks from starting edge/face around point on patch.
 
     -# Use in-place: \n
-        @code
+        \code
             patchPointEdgeCirculator circ(..);
 
             // Walk
@@ -38,10 +38,10 @@ Description
                 ++circ;
             }
             while (circ != circ.end());
-        @endcode
+        \endcode
 
     -# Use like STL iterator: \n
-        @code
+        \code
             patchPointEdgeCirculator circ(..);
             for
             (
@@ -52,7 +52,7 @@ Description
             {
                 Info<< "edge:" << iter.edgeID() << endl;
             }
-        @endcode
+        \endcode
 
 
 SourceFiles

applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -32,7 +32,7 @@ Usage
 
     - extrude2DMesh thickness
 
-    @param thickness \n
+    \param thickness \n
     Thickness (in metre) of slab.
 
 Note

applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -33,18 +33,18 @@ Usage
     for it. Normal behaviour is to have each point become a cell
     (1.5 behaviour)
 
-    @param -concaveMultiCells
+    \param -concaveMultiCells
     Creates multiple cells for each point on a concave edge. Might limit
     the amount of distortion on some meshes.
 
-    @param -splitAllFaces
+    \param -splitAllFaces
     Normally only constructs a single face between two cells. This single face
     might be too distorted. splitAllFaces will create a single face for every
     original cell the face passes through. The mesh will thus have
     multiple faces inbetween two cells! (so is not strictly upper-triangular
     anymore - checkMesh will complain)
 
-    @param -doNotPreserveFaceZones:
+    \param -doNotPreserveFaceZones:
     By default all faceZones are preserved by marking all faces, edges and
     points on them as features. The -doNotPreserveFaceZones disables this
     behaviour.

applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -40,7 +40,7 @@ Description
     Comparable to running a meshModifier of the form
     (if masterPatch is called "M" and slavePatch "S"):
 
-    @verbatim
+    \verbatim
     couple
     {
         type                    slidingInterface;
@@ -52,7 +52,7 @@ Description
         slavePatchName          S;
         typeOfMatch             partial or integral
     }
-    @endverbatim
+    \endverbatim
 
 
 \*---------------------------------------------------------------------------*/