From 1319df48d91193b8fe634831f97adde1a2c2f4a0 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Fri, 17 Jun 2016 09:11:58 +0100
Subject: [PATCH] Rationalized Doxygen documentation of command-line options
---
.../foamToStarMesh/foamToStarMesh.C | 16 ++--
.../conversion/foamToSurface/foamToSurface.C | 16 ++--
.../mesh/conversion/star4ToFoam/star4ToFoam.C | 24 ++---
.../mesh/generation/blockMesh/Make/files | 2 +-
.../blockMesh/{blockMeshApp.C => blockMesh.C} | 24 ++---
.../mesh/manipulation/checkMesh/checkMesh.C | 27 +++---
.../polyDualMesh/polyDualMeshApp.C | 41 ++++-----
.../foamDictionary/foamDictionary.C | 72 ++++++++-------
.../miscellaneous/foamList/foamList.C | 13 ++-
.../foamListTimes/foamListTimes.C | 11 +--
.../decomposePar/decomposePar.C | 61 ++++++-------
.../foamToEnsight/foamToEnsight.C | 26 +++---
.../foamToEnsightParts/foamToEnsightParts.C | 32 +++----
.../foamToTecplot360/foamToTecplot360.C | 59 ++++++-------
.../dataConversion/foamToVTK/foamToVTK.C | 87 ++++++++++---------
.../changeDictionary/changeDictionary.C | 22 ++---
.../foamUpgradeCyclics/foamUpgradeCyclics.C | 12 +--
.../surface/surfaceConvert/surfaceConvert.C | 17 ++--
.../surfaceMeshConvert/surfaceMeshConvert.C | 31 +++----
.../surfaceMeshConvertTesting.C | 25 +++---
.../surfaceMeshExport/surfaceMeshExport.C | 33 +++----
.../surfaceMeshImport/surfaceMeshImport.C | 33 +++----
.../surface/surfaceMeshInfo/surfaceMeshInfo.C | 15 ++--
src/OSspecific/POSIX/signals/sigFpe.H | 10 +--
src/OpenFOAM/db/IOobject/IOobject.H | 16 ++--
.../inputModeEntry/inputModeEntry.H | 14 +--
src/OpenFOAM/global/argList/argList.H | 22 ++---
.../coordinateSystems/coordinateSystem.H | 2 +-
28 files changed, 396 insertions(+), 367 deletions(-)
rename applications/utilities/mesh/generation/blockMesh/{blockMeshApp.C => blockMesh.C} (95%)
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index a345d300157..b02464d0c58 100644
--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/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) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,15 +28,15 @@ Description
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
Usage
- - foamToStarMesh [OPTION] \n
- Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
+ \b foamToStarMesh [OPTION]
- \param -noBnd \n
- Suppress writing the \c .bnd file
+ Options:
+ - \par -noBnd
+ Suppress writing the \c .bnd file
- \param -scale \<factor\>\n
- Specify an alternative geometry scaling factor.
- The default is \b 1000 (scale \em [m] to \em [mm]).
+ - \par -scale \<factor\>
+ Specify an alternative geometry scaling factor.
+ The default is \b 1000 (scale \em [m] to \em [mm]).
Note
The cellTable information available in the files
diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
index 9654b33fc23..d407c7f55fa 100644
--- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
+++ b/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) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,15 +28,15 @@ Description
Reads an OpenFOAM mesh and writes the boundaries in a surface format.
Usage
- - foamToSurface [OPTION] \n
- Reads an OpenFOAM mesh and writes the boundaries in a surface format.
+ \b foamToSurface [OPTION]
- \param -scale \<factor\>\n
- Specify an alternative geometry scaling factor.
- Eg, use \b 1000 to scale \em [m] to \em [mm].
+ Options:
+ - \par -scale \<factor\>
+ Specify an alternative geometry scaling factor.
+ E.g. use \b 1000 to scale \em [m] to \em [mm].
- \param -tri \n
- Triangulate surface.
+ - \par -tri
+ Triangulate surface.
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
index f8e1657e791..6748e7ba8c1 100644
--- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
+++ b/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) 2011-2013 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,22 +28,22 @@ Description
Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.
Usage
- - star4ToFoam [OPTION] ccmMesh\n
- convert pro-STAR mesh to OpenFOAM
+ \b star4ToFoam [OPTION] ccmMesh
- \param -ascii \n
- Write in ASCII format instead of binary
+ Options:
+ - \par -ascii
+ Write in ASCII format instead of binary
- \param -scale \<factor\>\n
- Specify an alternative geometry scaling factor.
- The default is \b 0.001 (scale \em [mm] to \em [m]).
+ - \par -scale \<factor\>
+ Specify an alternative geometry scaling factor.
+ The default is \b 0.001 (scale \em [mm] to \em [m]).
- \param -solids \n
- Treat any solid cells present just like fluid cells.
- The default is to discard them.
+ - \par -solids
+ Treat any solid cells present just like fluid cells.
+ The default is to discard them.
Note
- - baffles are written as interfaces for later use
+ Baffles are written as interfaces for later use
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/mesh/generation/blockMesh/Make/files b/applications/utilities/mesh/generation/blockMesh/Make/files
index 74840e97328..ec072da79bb 100644
--- a/applications/utilities/mesh/generation/blockMesh/Make/files
+++ b/applications/utilities/mesh/generation/blockMesh/Make/files
@@ -1,3 +1,3 @@
-blockMeshApp.C
+blockMesh.C
EXE = $(FOAM_APPBIN)/blockMesh
diff --git a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C b/applications/utilities/mesh/generation/blockMesh/blockMesh.C
similarity index 95%
rename from applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
rename to applications/utilities/mesh/generation/blockMesh/blockMesh.C
index 8715dc39ff4..1cfc7fe26e4 100644
--- a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
+++ b/applications/utilities/mesh/generation/blockMesh/blockMesh.C
@@ -28,23 +28,23 @@ Description
A multi-block mesh generator.
Uses the block mesh description found in
- \a system/blockMeshDict
- or \a system/\<region\>/blockMeshDict
- or \a constant/polyMesh/blockMeshDict
- or \a constant/\<region\>/polyMesh/blockMeshDict
+ - \c system/blockMeshDict
+ - \c system/\<region\>/blockMeshDict
+ - \c constant/polyMesh/blockMeshDict
+ - \c constant/\<region\>/polyMesh/blockMeshDict
Usage
+ \b blockMesh [OPTION]
- - blockMesh [OPTION]
+ Options:
+ - \par -blockTopology
+ Write the topology as a set of edges in OBJ format.
- \param -blockTopology \n
- Write the topology as a set of edges in OBJ format.
+ - \par -region \<name\>
+ Specify an alternative mesh region.
- \param -region \<name\> \n
- Specify an alternative mesh region.
-
- \param -dict \<filename\> \n
- Specify alternative dictionary for the block mesh description.
+ - \par -dict \<filename\>
+ Specify alternative dictionary for the block mesh description.
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
index 07b831e1fd0..ce83db08e5f 100644
--- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
+++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
@@ -28,23 +28,26 @@ Description
Checks validity of a mesh.
Usage
- - checkMesh [OPTION]
+ \b checkMesh [OPTION]
- \param -allGeometry \n
- Checks all (including non finite-volume specific) geometry
+ Options:
+ - \par -allGeometry
+ Checks all (including non finite-volume specific) geometry
- \param -allTopology \n
- Checks all (including non finite-volume specific) addressing
+ - \par -allTopology
+ Checks all (including non finite-volume specific) addressing
- \param -meshQuality \n
- Checks against user defined (in \a system/meshQualityDict) quality settings
+ - \par -meshQuality
+ Checks against user defined (in \a system/meshQualityDict) quality
+ settings
- \param -region \<name\> \n
- Specify an alternative mesh region.
+ - \par -region \<name\>
+ Specify an alternative mesh region.
- \param -writeSets \<surfaceFormat\> \n
- Reconstruct all cellSets and faceSets geometry and write to postProcessing/
- directory according to surfaceFormat (e.g. vtk or ensight)
+ - \par -writeSets \<surfaceFormat\>
+ Reconstruct all cellSets and faceSets geometry and write to
+ postProcessing directory according to surfaceFormat
+ (e.g. vtk or ensight)
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
index d862a71dde8..906cc0b4139 100644
--- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
@@ -29,31 +29,32 @@ Description
edges.
Usage
-
- - polyDualMesh featureAngle
+ \b polyDualMesh featureAngle
Detects any boundary edge > angle and creates multiple boundary faces
for it. Normal behaviour is to have each point become a cell
(1.5 behaviour)
- \param -concaveMultiCells
- Creates multiple cells for each point on a concave edge. Might limit
- the amount of distortion on some meshes.
-
- \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:
- By default all faceZones are preserved by marking all faces, edges and
- points on them as features. The -doNotPreserveFaceZones disables this
- behaviour.
-
- Note: is just a driver for meshDualiser. Substitute your own
- simpleMarkFeatures to have different behaviour.
+ Options:
+ - \par -concaveMultiCells
+ Creates multiple cells for each point on a concave edge. Might limit
+ the amount of distortion on some meshes.
+
+ - \par -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)
+
+ - \par -doNotPreserveFaceZones:
+ By default all faceZones are preserved by marking all faces, edges and
+ points on them as features. The -doNotPreserveFaceZones disables this
+ behaviour.
+
+Note
+ It is just a driver for meshDualiser. Substitute your own simpleMarkFeatures
+ to have different behaviour.
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
index 14f2f98e780..968d235e546 100644
--- a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
+++ b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
@@ -28,45 +28,55 @@ Description
Interrogates and manipulates dictionaries.
Usage
- - foamDictionary [OPTION] dictionary
+ \b foamDictionary [OPTION] dictionary
- \param -entry \<name\> \n
- Selects an entry
+ - \par -entry \<name\>
+ Selects an entry
- \param -keywords \<name\> \n
- Prints the keywords (of the selected entry or of the top level if
- no entry was selected
+ - \par -keywords \<name\>
+ Prints the keywords (of the selected entry or of the top level if
+ no entry was selected
- \param -add \<value\> \n
- Adds the entry (should not exist yet)
+ - \par -add \<value\>
+ Adds the entry (should not exist yet)
- \param -set \<value\> \n
- Adds or replaces the entry
+ - \par -set \<value\>
+ Adds or replaces the entry
- \param -expand \n
- Read the specified dictionary file, expand the macros etc. and write
- the resulting dictionary to standard output.
+ - \par -expand
+ Read the specified dictionary file, expand the macros etc. and write
+ the resulting dictionary to standard output.
- \param -includes \n
- List the #include/#includeIfPresent files to standard output.
+ - \par -includes
+ List the \c #include and \c #includeIfPresent files to standard output.
Typical usage:
- - change simulation to run for one timestep only:
- foamDictionary system/controlDict -entry stopAt -set writeNow;
-
- - change solver
- foamDictionary system/fvSolution -entry solvers.p.solver -set PCG
-
- - print bc type
- foamDictionary 0/U -entry boundaryField.movingWall.type
-
- - change bc parameter
- foamDictionary 0/U -entry boundaryField.movingWall.value \
- -set "uniform (2 0 0)"
-
- - change whole bc type
- foamDictionary 0/U -entry boundaryField.movingWall \
- -set "{type uniformFixedValue; uniformValue (2 0 0);}"
+ - Change simulation to run for one timestep only:
+ \verbatim
+ foamDictionary system/controlDict -entry stopAt -set writeNow
+ \endverbatim
+
+ - Change solver:
+ \verbatim
+ foamDictionary system/fvSolution -entry solvers.p.solver -set PCG
+ \endverbatim
+
+ - Print bc type:
+ \verbatim
+ foamDictionary 0/U -entry boundaryField.movingWall.type
+ \endverbatim
+
+ - Change bc parameter:
+ \verbatim
+ foamDictionary 0/U -entry boundaryField.movingWall.value \
+ -set "uniform (2 0 0)"
+ \endverbatim
+
+ - Change whole bc type:
+ \verbatim
+ foamDictionary 0/U -entry boundaryField.movingWall \
+ -set "{type uniformFixedValue; uniformValue (2 0 0);}"
+ \endverbatim
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/miscellaneous/foamList/foamList.C b/applications/utilities/miscellaneous/foamList/foamList.C
index 429e2c51137..5ad9c021827 100644
--- a/applications/utilities/miscellaneous/foamList/foamList.C
+++ b/applications/utilities/miscellaneous/foamList/foamList.C
@@ -28,13 +28,18 @@ Description
Print the table of contents of selectable switches, classes etc. in the
OpenFOAM libraries
- \par Command-line options
- \param -switches \n
+Usage
+ \b foamList [OPTION]
+
+ Options:
+ - \par -switches
Print the DebugSwitches, InfoSwitches and OptimisationSwitches
- \param -registeredSwitches \n
+
+ - \par -registeredSwitches
Print the registered DebugSwitches, InfoSwitches and
OptimisationSwitches supporting run-time modification
- \param -unset \n
+
+ - \par -unset
print switches declared in libraries but not set in etc/controlDict
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
index 9b21a00fee4..f395c5966f4 100644
--- a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
+++ b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
@@ -28,13 +28,14 @@ Description
List times using timeSelector.
Usage
+ \b foamListTimes [OPTION]
- - foamListTimes [OPTION]
+ Options:
+ - \par -rm
+ Remove selected time directories
- \param -rm \n
- Remove selected time directories
- \param -processor \n
- List times from processor0/ directory
+ - \par -processor
+ List times from processor0/ directory
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
index 4958b521e20..ee8c4f0d908 100644
--- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
+++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
@@ -29,46 +29,47 @@ Description
execution of OpenFOAM.
Usage
+ \b decomposePar [OPTION]
- - decomposePar [OPTION]
+ Options:
+ - \par -cellDist
+ Write the cell distribution as a labelList, for use with 'manual'
+ decomposition method or as a volScalarField for post-processing.
- \param -cellDist \n
- Write the cell distribution as a labelList, for use with 'manual'
- decomposition method or as a volScalarField for post-processing.
+ - \par -region \<regionName\> \n
+ Decompose named region. Does not check for existence of processor*.
- \param -region regionName \n
- Decompose named region. Does not check for existence of processor*.
+ - \par -allRegions \n
+ Decompose all regions in regionProperties. Does not check for
+ existence of processor*.
- \param -allRegions \n
- Decompose all regions in regionProperties. Does not check for
- existence of processor*.
+ - \par -copyUniform \n
+ Copy any \a uniform directories too.
- \param -copyUniform \n
- Copy any \a uniform directories too.
+ - \par -constant
- \param -constant \n
- \param -time xxx:yyy \n
- Override controlDict settings and decompose selected times. Does not
- re-decompose the mesh i.e. does not handle moving mesh or changing
- mesh cases.
+ - \par -time xxx:yyy \n
+ Override controlDict settings and decompose selected times. Does not
+ re-decompose the mesh i.e. does not handle moving mesh or changing
+ mesh cases.
- \param -fields \n
- Use existing geometry decomposition and convert fields only.
+ - \par -fields \n
+ Use existing geometry decomposition and convert fields only.
- \param -noSets \n
- Skip decomposing cellSets, faceSets, pointSets.
+ - \par -noSets \n
+ Skip decomposing cellSets, faceSets, pointSets.
- \param -force \n
- Remove any existing \a processor subdirectories before decomposing the
- geometry.
+ - \par -force \n
+ Remove any existing \a processor subdirectories before decomposing the
+ geometry.
- \param -ifRequired \n
- Only decompose the geometry if the number of domains has changed from a
- previous decomposition. No \a processor subdirectories will be removed
- unless the \a -force option is also specified. This option can be used
- to avoid redundant geometry decomposition (eg, in scripts), but should
- be used with caution when the underlying (serial) geometry or the
- decomposition method etc. have been changed between decompositions.
+ - \par -ifRequired \n
+ Only decompose the geometry if the number of domains has changed from a
+ previous decomposition. No \a processor subdirectories will be removed
+ unless the \a -force option is also specified. This option can be used
+ to avoid redundant geometry decomposition (eg, in scripts), but should
+ be used with caution when the underlying (serial) geometry or the
+ decomposition method etc. have been changed between decompositions.
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
index 1cd3cbe37d0..c3357c0d0db 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
@@ -30,24 +30,24 @@ Description
An Ensight part is created for the internalMesh and for each patch.
Usage
- - foamToEnsight [OPTION] \n
- Translates OpenFOAM data to Ensight format
+ \b foamToEnsight [OPTION]
- \param -ascii \n
- Write Ensight data in ASCII format instead of "C Binary"
+ Options:
+ - \par -ascii
+ Write Ensight data in ASCII format instead of "C Binary"
- \param -patches patchList \n
- Specify particular patches to write.
- Specifying an empty list suppresses writing the internalMesh.
+ - \par -patches patchList
+ Specify particular patches to write.
+ Specifying an empty list suppresses writing the internalMesh.
- \param -noPatches \n
- Suppress writing any patches.
+ - \par -noPatches
+ Suppress writing any patches.
- \param -faceZones zoneList \n
- Specify faceZones to write, with wildcards
+ - \par -faceZones zoneList
+ Specify faceZones to write, with wildcards
- \param -cellZone zoneName \n
- Specify single cellZone to write (not lagrangian)
+ - \par -cellZone zoneName
+ Specify single cellZone to write (not lagrangian)
Note
Parallel support for cloud data is not supported
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
index 6aecc40fc2e..4d88ebf1e18 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
@@ -29,28 +29,28 @@ Description
An Ensight part is created for each cellZone and patch.
Usage
- - foamToEnsightParts [OPTION] \n
- Translates OpenFOAM data to Ensight format
+ \b foamToEnsightParts [OPTION]
- \param -ascii \n
- Write Ensight data in ASCII format instead of "C Binary"
+ Options:
+ - \par -ascii
+ Write Ensight data in ASCII format instead of "C Binary"
- \param -name \<subdir\>\n
- define sub-directory name to use for Ensight data (default: "Ensight")
+ - \par -name \<subdir\>
+ Define sub-directory name to use for Ensight data (default: "Ensight")
- \param -noZero \n
- Exclude the often incomplete initial conditions.
+ - \par -noZero
+ Exclude the often incomplete initial conditions.
- \param -index \<start\>\n
- Ignore the time index contained in the time file and use a
- simple indexing when creating the \c Ensight/data/######## files.
+ - \par -index \<start\>
+ Ignore the time index contained in the time file and use a
+ simple indexing when creating the \c Ensight/data/######## files.
- \param -noMesh \n
- Suppress writing the geometry. Can be useful for converting partial
- results for a static geometry.
+ - \par -noMesh
+ Suppress writing the geometry. Can be useful for converting partial
+ results for a static geometry.
- \param -width \<n\>\n
- width of Ensight data subdir
+ - \par -width \<n\>
+ Width of Ensight data subdir
Note
- no parallel data.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
index 52a3fa22c5d..5bc27c7dc7b 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
@@ -28,44 +28,45 @@ Description
Tecplot binary file format writer.
Usage
+ \b foamToTecplot360 [OPTION]
- - foamToTecplot360 [OPTION]
+ Options:
+ - \par -fields \<names\>
+ Convert selected fields only. For example,
+ \verbatim
+ -fields '( p T U )'
+ \endverbatim
+ The quoting is required to avoid shell expansions and to pass the
+ information as a single argument.
- \param -fields \<names\>\n
- Convert selected fields only. For example,
- \verbatim
- -fields '( p T U )'
- \endverbatim
- The quoting is required to avoid shell expansions and to pass the
- information as a single argument.
+ - \par -cellSet \<name\>
- \param -cellSet \<name\>\n
- \param -faceSet \<name\>\n
- Restrict conversion to the cellSet, faceSet.
+ - \par -faceSet \<name\>
+ Restrict conversion to the cellSet, faceSet.
- \param -nearCellValue \n
- Output cell value on patches instead of patch value itself
+ - \par -nearCellValue
+ Output cell value on patches instead of patch value itself
- \param -noInternal \n
- Do not generate file for mesh, only for patches
+ - \par -noInternal
+ Do not generate file for mesh, only for patches
- \param -noPointValues \n
- No pointFields
+ - \par -noPointValues
+ No pointFields
- \param -noFaceZones \n
- No faceZones
+ - \par -noFaceZones
+ No faceZones
- \param -excludePatches \<patchNames\>\n
- Specify patches (wildcards) to exclude. For example,
- \verbatim
- -excludePatches '( inlet_1 inlet_2 "proc.*")'
- \endverbatim
- The quoting is required to avoid shell expansions and to pass the
- information as a single argument. The double quotes denote a regular
- expression.
+ - \par -excludePatches \<patchNames\>
+ Specify patches (wildcards) to exclude. For example,
+ \verbatim
+ -excludePatches '( inlet_1 inlet_2 "proc.*")'
+ \endverbatim
+ The quoting is required to avoid shell expansions and to pass the
+ information as a single argument. The double quotes denote a regular
+ expression.
- \param -useTimeName \n
- use the time index in the VTK file name instead of the time index
+ - \par -useTimeName
+ use the time index in the VTK file name instead of the time index
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
index f490f220df2..8c3f3d3459c 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
@@ -37,63 +37,64 @@ Description
handled by vtk.
Usage
+ \b foamToVTK [OPTION]
- - foamToVTK [OPTION]
+ Options:
+ - \par -ascii
+ Write VTK data in ASCII format instead of binary.
- \param -ascii \n
- Write VTK data in ASCII format instead of binary.
+ - \par -mesh \<name\>
+ Use a different mesh name (instead of -region)
- \param -mesh \<name\>\n
- Use a different mesh name (instead of -region)
+ - \par -fields \<fields\>
+ Convert selected fields only. For example,
+ \verbatim
+ -fields "( p T U )"
+ \endverbatim
+ The quoting is required to avoid shell expansions and to pass the
+ information as a single argument.
- \param -fields \<fields\>\n
- Convert selected fields only. For example,
- \verbatim
- -fields "( p T U )"
- \endverbatim
- The quoting is required to avoid shell expansions and to pass the
- information as a single argument.
+ - \par -surfaceFields
+ Write surfaceScalarFields (e.g., phi)
- \param -surfaceFields \n
- Write surfaceScalarFields (e.g., phi)
+ - \par -cellSet \<name\>
+ - \par -faceSet \<name\>
- \param -cellSet \<name\>\n
- \param -faceSet \<name\>\n
- \param -pointSet \<name\>\n
- Restrict conversion to the cellSet, faceSet or pointSet.
+ - \par -pointSet \<name\>
+ Restrict conversion to the cellSet, faceSet or pointSet.
- \param -nearCellValue \n
- Output cell value on patches instead of patch value itself
+ - \par -nearCellValue
+ Output cell value on patches instead of patch value itself
- \param -noInternal \n
- Do not generate file for mesh, only for patches
+ - \par -noInternal
+ Do not generate file for mesh, only for patches
- \param -noPointValues \n
- No pointFields
+ - \par -noPointValues
+ No pointFields
- \param -noFaceZones \n
- No faceZones
+ - \par -noFaceZones
+ No faceZones
- \param -noLinks \n
- (in parallel) do not link processor files to master
+ - \par -noLinks
+ (in parallel) do not link processor files to master
- \param poly \n
- write polyhedral cells without tet/pyramid decomposition
+ - \par poly
+ write polyhedral cells without tet/pyramid decomposition
- \param -allPatches \n
- Combine all patches into a single file
+ - \par -allPatches
+ Combine all patches into a single file
- \param -excludePatches \<patchNames\>\n
- Specify patches (wildcards) to exclude. For example,
- \verbatim
- -excludePatches '( inlet_1 inlet_2 "proc.*")'
- \endverbatim
- The quoting is required to avoid shell expansions and to pass the
- information as a single argument. The double quotes denote a regular
- expression.
+ - \par -excludePatches \<patchNames\>
+ Specify patches (wildcards) to exclude. For example,
+ \verbatim
+ -excludePatches '( inlet_1 inlet_2 "proc.*")'
+ \endverbatim
+ The quoting is required to avoid shell expansions and to pass the
+ information as a single argument. The double quotes denote a regular
+ expression.
- \param -useTimeName \n
- use the time index in the VTK file name instead of the time index
+ - \par -useTimeName
+ use the time index in the VTK file name instead of the time index
Note
mesh subset is handled by vtkMesh. Slight inconsistency in
@@ -105,7 +106,7 @@ Note
whole-mesh values onto the subset patch.
Note
- new file format: \n
+ \par new file format:
no automatic timestep recognition.
However can have .pvd file format which refers to time simulation
if XML *.vtu files are available:
diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
index 0eb9f7f349f..c2437b5b235 100644
--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@@ -52,21 +52,21 @@ Description
Replacement entries starting with '~' will remove the entry.
Usage
+ \b changeDictionary [OPTION]
- changeDictionary [OPTION]
+ Options:
+ - \par -subDict
+ Specify the subDict name of the replacements dictionary.
- \param -subDict \n
- Specify the subDict name of the replacements dictionary.
+ - \par -literalRE
+ Do not interpret regular expressions or patchGroups; treat them as any
+ other keyword.
- \param -literalRE \n
- Do not interpret regular expressions or patchGroups; treat them as any
- other keyword.
+ - \par -enableFunctionEntries
+ Enable function entries (default: disabled)
- \param -enableFunctionEntries \n
- Enable function entries (default: disabled)
-
- \param -disablePatchGroups \n
- Disable the default checking for keys being patchGroups
+ - \par -disablePatchGroups
+ Disable the default checking for keys being patchGroups
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
index 5de3e18624e..a81446d8b88 100644
--- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
+++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
@@ -28,14 +28,14 @@ Description
Tool to upgrade mesh and fields for split cyclics.
Usage
+ \b foamUpgradeCyclics [OPTION]
- - foamUpgradeCyclics [OPTION]
+ Options:
+ - \par -test
+ Suppress writing the updated files with split cyclics
- \param -test \n
- Suppress writing the updated files with split cyclics
-
- \param -enableFunctionEntries \n
- By default all dictionary preprocessing of fields is disabled
+ - \par -enableFunctionEntries
+ By default all dictionary preprocessing of fields is disabled
\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/surface/surfaceConvert/surfaceConvert.C b/applications/utilities/surface/surfaceConvert/surfaceConvert.C
index 1d79b08059b..02e10b9f0bf 100644
--- a/applications/utilities/surface/surfaceConvert/surfaceConvert.C
+++ b/applications/utilities/surface/surfaceConvert/surfaceConvert.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,16 +28,17 @@ Description
Converts from one surface mesh format to another.
Usage
- - surfaceConvert inputFile outputFile [OPTION]
+ \b surfaceConvert inputFile outputFile [OPTION]
- \param -clean \n
- Perform some surface checking/cleanup on the input surface
+ Options:
+ - \par -clean
+ Perform some surface checking/cleanup on the input surface
- \param -scale \<scale\> \n
- Specify a scaling factor for writing the files
+ - \par -scale \<scale\>
+ Specify a scaling factor for writing the files
- \param -group \n
- Orders faces by region
+ - \par -group
+ Orders faces by region
Note
The filename extensions are used to determine the file format type.
diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
index b656a484bf5..c6e6821395c 100644
--- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
+++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
@@ -29,28 +29,29 @@ Description
transformations (rotate/translate) on a coordinateSystem.
Usage
- - surfaceMeshConvert inputFile outputFile [OPTION]
+ \b surfaceMeshConvert inputFile outputFile [OPTION]
- \param -clean \n
- Perform some surface checking/cleanup on the input surface.
+ Options:
+ - \par -clean
+ Perform some surface checking/cleanup on the input surface.
- \param -scaleIn \<scale\> \n
- Specify a scaling factor when reading files.
+ - \par -scaleIn \<scale\>
+ Specify a scaling factor when reading files.
- \param -scaleOut \<scale\> \n
- Specify a scaling factor when writing files.
+ - \par -scaleOut \<scale\>
+ Specify a scaling factor when writing files.
- \param -dict \<dictionary\> \n
- Specify an alternative dictionary for constant/coordinateSystems.
+ - \par -dict \<dictionary\>
+ Specify an alternative dictionary for constant/coordinateSystems.
- \param -from \<coordinateSystem\> \n
- Specify a coordinate System when reading files.
+ - \par -from \<coordinateSystem\>
+ Specify a coordinate System when reading files.
- \param -to \<coordinateSystem\> \n
- Specify a coordinate System when writing files.
+ - \par -to \<coordinateSystem\>
+ Specify a coordinate System when writing files.
- \param -tri \n
- Triangulate surface.
+ - \par -tri
+ Triangulate surface.
Note
The filename extensions are used to determine the file format type.
diff --git a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
index 12bd9f32e22..da8c20b9975 100644
--- a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
+++ b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -29,22 +29,23 @@ Description
used for testing functionality.
Usage
- - surfaceMeshConvertTesting inputFile outputFile [OPTION]
+ \b surfaceMeshConvertTesting inputFile outputFile [OPTION]
- \param -clean \n
- Perform some surface checking/cleanup on the input surface
+ Options:
+ - \par -clean
+ Perform some surface checking/cleanup on the input surface
- \param -orient \n
- Check face orientation on the input surface
+ - \par -orient
+ Check face orientation on the input surface
- \param -scale \<scale\> \n
- Specify a scaling factor for writing the files
+ - \par -scale \<scale\>
+ Specify a scaling factor for writing the files
- \param -triSurface \n
- Use triSurface library for input/output
+ - \par -triSurface
+ Use triSurface library for input/output
- \param -keyed \n
- Use keyedSurface for input/output
+ - \par -keyed
+ Use keyedSurface for input/output
Note
The filename extensions are used to determine the file format type.
diff --git a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
index 4b8d230080a..bd9d7c75aad 100644
--- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
+++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -30,28 +30,29 @@ Description
coordinateSystem.
Usage
- - surfaceMeshExport outputFile [OPTION]
+ \b surfaceMeshExport outputFile [OPTION]
- \param -clean \n
- Perform some surface checking/cleanup on the input surface.
+ Options:
+ - \par -clean
+ Perform some surface checking/cleanup on the input surface.
- \param -name \<name\> \n
- Specify an alternative surface name when writing.
+ - \par -name \<name\>
+ Specify an alternative surface name when writing.
- \param -scaleIn \<scale\> \n
- Specify a scaling factor when reading files.
+ - \par -scaleIn \<scale\>
+ Specify a scaling factor when reading files.
- \param -scaleOut \<scale\> \n
- Specify a scaling factor when writing files.
+ - \par -scaleOut \<scale\>
+ Specify a scaling factor when writing files.
- \param -dict \<dictionary\> \n
- Specify an alternative dictionary for constant/coordinateSystems.
+ - \par -dict \<dictionary\>
+ Specify an alternative dictionary for constant/coordinateSystems.
- \param -from \<coordinateSystem\> \n
- Specify a coordinate system when reading files.
+ - \par -from \<coordinateSystem\>
+ Specify a coordinate system when reading files.
- \param -to \<coordinateSystem\> \n
- Specify a coordinate system when writing files.
+ - \par -to \<coordinateSystem\>
+ Specify a coordinate system when writing files.
Note
The filename extensions are used to determine the file format type.
diff --git a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
index 2bf0c9c014e..2e88f775d06 100644
--- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
+++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -30,28 +30,29 @@ Description
on a coordinateSystem.
Usage
- - surfaceMeshImport inputFile [OPTION]
+ \b surfaceMeshImport inputFile [OPTION]
- \param -clean \n
- Perform some surface checking/cleanup on the input surface.
+ Options:
+ - \par -clean \n
+ Perform some surface checking/cleanup on the input surface.
- \param -name \<name\> \n
- Specify an alternative surface name when writing.
+ - \par -name \<name\> \n
+ Specify an alternative surface name when writing.
- \param -scaleIn \<scale\> \n
- Specify a scaling factor when reading files.
+ - \par -scaleIn \<scale\> \n
+ Specify a scaling factor when reading files.
- \param -scaleOut \<scale\> \n
- Specify a scaling factor when writing files.
+ - \par -scaleOut \<scale\> \n
+ Specify a scaling factor when writing files.
- \param -dict \<dictionary\> \n
- Specify an alternative dictionary for constant/coordinateSystems.
+ - \par -dict \<dictionary\> \n
+ Specify an alternative dictionary for constant/coordinateSystems.
- \param -from \<coordinateSystem\> \n
- Specify a coordinate system when reading files.
+ - \par -from \<coordinateSystem\> \n
+ Specify a coordinate system when reading files.
- \param -to \<coordinateSystem\> \n
- Specify a coordinate system when writing files.
+ - \par -to \<coordinateSystem\> \n
+ Specify a coordinate system when writing files.
Note
The filename extensions are used to determine the file format type.
diff --git a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
index 4a48ada7606..10d9b0d8fd9 100644
--- a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
+++ b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
@@ -28,16 +28,17 @@ Description
Miscellaneous information about surface meshes.
Usage
- - surfaceMeshInfo surfaceFile [OPTION]
+ \b surfaceMeshInfo surfaceFile [OPTION]
- \param -areas \n
- Report area for each face.
+ Options:
+ - \par -areas
+ Report area for each face.
- \param -scale \<scale\> \n
- Specify a scaling factor when reading files.
+ - \par -scale \<scale\>
+ Specify a scaling factor when reading files.
- \param -xml \n
- Write output in XML format.
+ - \par -xml
+ Write output in XML format.
Note
The filename extensions are used to determine the file format type.
diff --git a/src/OSspecific/POSIX/signals/sigFpe.H b/src/OSspecific/POSIX/signals/sigFpe.H
index 603c4b5ea00..14dbcaeb88d 100644
--- a/src/OSspecific/POSIX/signals/sigFpe.H
+++ b/src/OSspecific/POSIX/signals/sigFpe.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,10 +28,10 @@ Description
Set up trapping for floating point exceptions (signal FPE).
Controlled by two env vars:
- \param FOAM_SIGFPE \n
- exception trapping
- \param FOAM_SETNAN \n
- initialization of all malloced memory to NaN. If FOAM_SIGFPE
+ - \par FOAM_SIGFPE
+ Exception trapping
+ - \par FOAM_SETNAN
+ Initialization of all malloced memory to NaN. If FOAM_SIGFPE
also set, this will cause usage of uninitialized scalars to trigger
an abort.
diff --git a/src/OpenFOAM/db/IOobject/IOobject.H b/src/OpenFOAM/db/IOobject/IOobject.H
index da8f443447f..15235b947e8 100644
--- a/src/OpenFOAM/db/IOobject/IOobject.H
+++ b/src/OpenFOAM/db/IOobject/IOobject.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -36,29 +36,29 @@ Description
\par Read options
Define what is done on object construction and explicit reads:
- \param MUST_READ
+ - \par MUST_READ
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read.
Does not check timestamp or re-read.
- \param MUST_READ_IF_MODIFIED
+ - \par MUST_READ_IF_MODIFIED
Object must be read from Istream on construction. \n
Error if Istream does not exist or can't be read. If object is
registered its timestamp will be checked every timestep and possibly
re-read.
- \param READ_IF_PRESENT
+ - \par READ_IF_PRESENT
Read object from Istream if Istream exists, otherwise don't. \n
Error only if Istream exists but can't be read.
Does not check timestamp or re-read.
- \param NO_READ
- Don't read
+ - \par NO_READ
+ Don't read
\par Write options
Define what is done on object destruction and explicit writes:
- \param AUTO_WRITE
+ - \par AUTO_WRITE
Object is written automatically when requested to by the
objectRegistry.
- \param NO_WRITE
+ - \par NO_WRITE
No automatic write on destruction but can be written explicitly
SourceFiles
diff --git a/src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H
index 33255e6502e..623524cd804 100644
--- a/src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H
+++ b/src/OpenFOAM/db/dictionary/functionEntries/inputModeEntry/inputModeEntry.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -34,12 +34,12 @@ Description
\endverbatim
The possible input modes:
- \param merge merge sub-dictionaries when possible
- \param overwrite keep last entry and silently remove previous ones
- \param protect keep initial entry and silently ignore subsequent ones
- \param warn keep initial entry and warn about subsequent ones
- \param error issue a FatalError for duplicate entries
- \param default currently identical to merge
+ - \par merge merge sub-dictionaries when possible
+ - \par overwrite keep last entry and silently remove previous ones
+ - \par protect keep initial entry and silently ignore subsequent ones
+ - \par warn keep initial entry and warn about subsequent ones
+ - \par error issue a FatalError for duplicate entries
+ - \par default currently identical to merge
SourceFiles
inputModeEntry.C
diff --git a/src/OpenFOAM/global/argList/argList.H b/src/OpenFOAM/global/argList/argList.H
index 9a0b9763508..a3df89afd41 100644
--- a/src/OpenFOAM/global/argList/argList.H
+++ b/src/OpenFOAM/global/argList/argList.H
@@ -39,17 +39,17 @@ Description
\endverbatim
The backslash-escaping is required to avoid interpretation by the shell.
- \par Default command-line options
- \param -case \<dir\> \n
- select a case directory instead of the current working directory
- \param -parallel \n
- specify case as a parallel job
- \param -doc \n
- display the documentation in browser
- \param -srcDoc \n
- display the source documentation in browser
- \param -help \n
- print the usage
+ Default command-line options:
+ - \par -case \<dir\>
+ Select a case directory instead of the current working directory
+ - \par -parallel
+ Specify case as a parallel job
+ - \par -doc
+ Display the documentation in browser
+ - \par -srcDoc
+ Display the source documentation in browser
+ - \par -help
+ Print the usage
The environment variable \b FOAM_CASE is set to the path of the
global case (same for serial and parallel jobs).
diff --git a/src/meshTools/coordinateSystems/coordinateSystem.H b/src/meshTools/coordinateSystems/coordinateSystem.H
index bc1d9003cc1..561482a2fde 100644
--- a/src/meshTools/coordinateSystems/coordinateSystem.H
+++ b/src/meshTools/coordinateSystems/coordinateSystem.H
@@ -286,7 +286,7 @@ public:
}
//- Return as dictionary of entries
- // \param [in] ignoreType drop type (cartesian, cylindrical, etc)
+ // \param[in] ignoreType drop type (cartesian, cylindrical, etc)
// when generating the dictionary
virtual dictionary dict(bool ignoreType=false) const;
--
GitLab