From 4e483cc98e7bc395e7d2d84681159ddc11cc0536 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Fri, 30 Oct 2015 21:37:03 +0000
Subject: [PATCH] Updated docs for Doxygen: '<' -> '\<' and '>' -> '\>'
---
.../mesh/manipulation/refineMesh/refineMesh.C | 2 +-
...oupledTemperatureMixedFvPatchScalarField.H | 26 +++++++++----------
.../externalCoupledMixedFvPatchField.H | 26 +++++++++----------
.../limitedSnGrad/limitedSnGrad.H | 4 +--
.../ConeNozzleInjection/ConeNozzleInjection.H | 2 +-
.../decompose/scotchDecomp/scotchDecomp.C | 4 +--
6 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
index 02888c6d6bf..2e32767822e 100644
--- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
+++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
@@ -29,7 +29,7 @@ Description
Command-line option handling:
- If -all specified or no refineMeshDict exists or, refine all cells
- - If -dict {file} specified refine according to {file}
+ - If -dict \<file\> specified refine according to \<file\>
- If refineMeshDict exists refine according to refineMeshDict
When the refinement or all cells is selected apply 3D refinement for 3D
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
index 47fb9153185..763f285560f 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
@@ -32,25 +32,25 @@ Description
application. Values are transferred as plain text files, where OpenFOAM
data is written as:
- # Patch: <patch name>
- <magSf1> <value1> <qDot1> <htc1>
- <magSf2> <value2> <qDot2> <htc2>
- <magSf3> <value3> <qDot3> <htc2>
+ # Patch: \<patch name\>
+ \<magSf1\> \<value1\> \<qDot1\> \<htc1\>
+ \<magSf2\> \<value2\> \<qDot2\> \<htc2\>
+ \<magSf3\> \<value3\> \<qDot3\> \<htc2\>
...
- <magSfN> <valueN> <qDotN> <htcN>
+ \<magSfN\> \<valueN\> \<qDotN\> \<htcN\>
and received as the constituent pieces of the `mixed' condition, i.e.
- # Patch: <patch name>
- <value1> <gradient1> <valueFracion1>
- <value2> <gradient2> <valueFracion2>
- <value3> <gradient3> <valueFracion3>
+ # Patch: \<patch name\>
+ \<value1\> \<gradient1\> \<valueFracion1\>
+ \<value2\> \<gradient2\> \<valueFracion2\>
+ \<value3\> \<gradient3\> \<valueFracion3\>
...
- <valueN> <gradientN> <valueFracionN>
+ \<valueN\> \<gradientN\> \<valueFracionN\>
Data is sent/received as a single file for all patches from the directory
- $FOAM_CASE/<commsDir>
+ $FOAM_CASE/\<commsDir\>
At start-up, the boundary creates a lock file, i.e..
@@ -59,13 +59,13 @@ Description
... to signal the external source to wait. During the boundary condition
update, boundary values are written to file, e.g.
- <fileName>.out
+ \<fileName\>.out
The lock file is then removed, instructing the external source to take
control of the program execution. When ready, the external program
should create the return values, e.g. to file
- <fileName>.in
+ \<fileName\>.in
... and then re-instate the lock file. The boundary condition will then
read the return values, and pass program execution back to OpenFOAM.
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
index 322ba3810b7..65a5d6d2562 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
@@ -32,25 +32,25 @@ Description
Values are transferred as plain text files, where OpenFOAM data is written
as:
- # Patch: <patch name>
- <magSf1> <value1> <surfaceNormalGradient1>
- <magSf2> <value2> <surfaceNormalGradient2>
- <magSf3> <value3> <surfaceNormalGradient3>
+ # Patch: \<patch name\>
+ \<magSf1\> \<value1\> \<surfaceNormalGradient1\>
+ \<magSf2\> \<value2\> \<surfaceNormalGradient2\>
+ \<magSf3\> \<value3\> \<surfaceNormalGradient3\>
...
- <magSfN> <valueN> <surfaceNormalGradientN>
+ \<magSfN\> \<valueN\> \<surfaceNormalGradientN\>
and received as the constituent pieces of the `mixed' condition, i.e.
- # Patch: <patch name>
- <value1> <gradient1> <valueFracion1>
- <value2> <gradient2> <valueFracion2>
- <value3> <gradient3> <valueFracion3>
+ # Patch: \<patch name\>
+ \<value1\> \<gradient1\> \<valueFracion1\>
+ \<value2\> \<gradient2\> \<valueFracion2\>
+ \<value3\> \<gradient3\> \<valueFracion3\>
...
- <valueN> <gradientN> <valueFracionN>
+ \<valueN\> \<gradientN\> \<valueFracionN\>
Data is sent/received as a single file for all patches from the directory
- $FOAM_CASE/<commsDir>
+ $FOAM_CASE/\<commsDir\>
At start-up, the boundary creates a lock file, i.e..
@@ -59,13 +59,13 @@ Description
... to signal the external source to wait. During the boundary condition
update, boundary values are written to file, e.g.
- <fileName>.out
+ \<fileName\>.out
The lock file is then removed, instructing the external source to take
control of the program execution. When ready, the external program
should create the return values, e.g. to file
- <fileName>.in
+ \<fileName\>.in
... and then re-instate the lock file. The boundary condition will then
read the return values, and pass program execution back to OpenFOAM.
diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H
index 5d1ffd2b940..ddb0c3e07c9 100644
--- a/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H
+++ b/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H
@@ -34,11 +34,11 @@ Description
non-orthogonal contribution does not exceed the orthogonal part.
Format:
- limited <corrected scheme> <coefficient>;
+ limited \<corrected scheme\> \<coefficient\>;
or
- limited <coefficient>; // Backward compatibility
+ limited \<coefficient\>; // Backward compatibility
SourceFiles
limitedSnGrad.C
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
index bd67443ce15..1d32db5f728 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
@@ -39,7 +39,7 @@ Description
- Parcel velocity is calculated as:
- Constant velocity
- U = <specified by user>
+ U = \<specified by user\>
- Pressure driven velocity
U = sqrt(2*(Pinj - Pamb)/rho)
- Flow rate and discharge
diff --git a/src/parallel/decompose/scotchDecomp/scotchDecomp.C b/src/parallel/decompose/scotchDecomp/scotchDecomp.C
index 464d12b28fa..f22a2ed0e01 100644
--- a/src/parallel/decompose/scotchDecomp/scotchDecomp.C
+++ b/src/parallel/decompose/scotchDecomp/scotchDecomp.C
@@ -114,8 +114,8 @@ License
}
- Note: instead of gmap run gpart <nProcs> -vs <grfFile>
- where <grfFile> can be obtained by running with 'writeGraph=true'
+ Note: instead of gmap run gpart \<nProcs\> -vs \<grfFile\>
+ where \<grfFile\> can be obtained by running with 'writeGraph=true'
\*---------------------------------------------------------------------------*/
--
GitLab