From cb5617e070a7204bbb0d9082589e832a675e3330 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Fri, 11 Jan 2019 08:22:02 +0100 Subject: [PATCH] STYLE: fix some doxygen markup - missing verbatim/endverbatim markers, missing "Foam::" prefix, typos --- .../parallelProcessing/decomposePar/faFieldDecomposer.H | 2 +- .../parallelProcessing/decomposePar/faMeshDecomposition.H | 2 +- .../reconstructPar/faFieldReconstructor.H | 5 ++--- .../parallelProcessing/reconstructPar/processorFaMeshes.H | 3 +-- src/OpenFOAM/containers/HashTables/HashOps/HashOps.H | 4 ++-- src/OpenFOAM/containers/HashTables/HashTableFwd.H | 2 +- src/OpenFOAM/containers/Lists/ListOps/ListOps.H | 2 +- src/OpenFOAM/db/IOstreams/hashes/base64Layer.H | 2 +- src/OpenFOAM/primitives/strings/lists/stringListOps.H | 2 +- src/Pstream/mpi/allReduce.H | 2 +- src/finiteArea/fields/edgeFields/edgeFields.H | 2 +- src/finiteArea/fields/edgeFields/edgeFieldsFwd.H | 8 +++----- .../turbulentDFSEMInletFvPatchVectorField.H | 3 ++- .../lagrangian/common/parcelSelectionDetail.H | 2 +- 14 files changed, 19 insertions(+), 22 deletions(-) diff --git a/applications/utilities/parallelProcessing/decomposePar/faFieldDecomposer.H b/applications/utilities/parallelProcessing/decomposePar/faFieldDecomposer.H index b9a33275d9..06c4813e55 100644 --- a/applications/utilities/parallelProcessing/decomposePar/faFieldDecomposer.H +++ b/applications/utilities/parallelProcessing/decomposePar/faFieldDecomposer.H @@ -24,7 +24,7 @@ License along with OpenFOAM. If not, see . Class - faFieldDecomposer + Foam::faFieldDecomposer Description Finite Area area and edge field decomposer. diff --git a/applications/utilities/parallelProcessing/decomposePar/faMeshDecomposition.H b/applications/utilities/parallelProcessing/decomposePar/faMeshDecomposition.H index 930a4fd036..33537d3f73 100644 --- a/applications/utilities/parallelProcessing/decomposePar/faMeshDecomposition.H +++ b/applications/utilities/parallelProcessing/decomposePar/faMeshDecomposition.H @@ -24,7 +24,7 @@ License along with OpenFOAM. If not, see . Class - faMeshDecomposition + Foam::faMeshDecomposition Description Automatic faMesh decomposition class diff --git a/applications/utilities/parallelProcessing/reconstructPar/faFieldReconstructor.H b/applications/utilities/parallelProcessing/reconstructPar/faFieldReconstructor.H index 6b97b8a4ac..6a297b691a 100644 --- a/applications/utilities/parallelProcessing/reconstructPar/faFieldReconstructor.H +++ b/applications/utilities/parallelProcessing/reconstructPar/faFieldReconstructor.H @@ -24,10 +24,10 @@ License along with OpenFOAM. If not, see . Class - faFieldReconstructor + Foam::faFieldReconstructor Description - FA area and edge field reconstructor. + Finite Area area and edge fields reconstruction. Author Zeljko Tukovic, FSB Zagreb @@ -53,7 +53,6 @@ SourceFiles namespace Foam { - /*---------------------------------------------------------------------------*\ Class faFieldReconstructor Declaration \*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/parallelProcessing/reconstructPar/processorFaMeshes.H b/applications/utilities/parallelProcessing/reconstructPar/processorFaMeshes.H index 8d82d3505b..b514406f15 100644 --- a/applications/utilities/parallelProcessing/reconstructPar/processorFaMeshes.H +++ b/applications/utilities/parallelProcessing/reconstructPar/processorFaMeshes.H @@ -24,7 +24,7 @@ License along with OpenFOAM. If not, see . Class - processorFaMeshes + Foam::processorFaMeshes Description Container for processor mesh addressing. @@ -51,7 +51,6 @@ SourceFiles namespace Foam { - /*---------------------------------------------------------------------------*\ Class processorFaMeshes Declaration \*---------------------------------------------------------------------------*/ diff --git a/src/OpenFOAM/containers/HashTables/HashOps/HashOps.H b/src/OpenFOAM/containers/HashTables/HashOps/HashOps.H index dee518a007..9372a0ff64 100644 --- a/src/OpenFOAM/containers/HashTables/HashOps/HashOps.H +++ b/src/OpenFOAM/containers/HashTables/HashOps/HashOps.H @@ -21,13 +21,13 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Namspace +Namespace Foam::HashSetOps Description Various operations for HashSet. -Namspace +Namespace Foam::HashTableOps Description diff --git a/src/OpenFOAM/containers/HashTables/HashTableFwd.H b/src/OpenFOAM/containers/HashTables/HashTableFwd.H index 2b3fe403b1..960cf3f9e1 100644 --- a/src/OpenFOAM/containers/HashTables/HashTableFwd.H +++ b/src/OpenFOAM/containers/HashTables/HashTableFwd.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -InNamspace +InNamespace Foam Description diff --git a/src/OpenFOAM/containers/Lists/ListOps/ListOps.H b/src/OpenFOAM/containers/Lists/ListOps/ListOps.H index 14eb3171b5..12ae68cc8f 100644 --- a/src/OpenFOAM/containers/Lists/ListOps/ListOps.H +++ b/src/OpenFOAM/containers/Lists/ListOps/ListOps.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -InNamspace +InNamespace Foam Description diff --git a/src/OpenFOAM/db/IOstreams/hashes/base64Layer.H b/src/OpenFOAM/db/IOstreams/hashes/base64Layer.H index 3456aa2e13..6567fdeded 100644 --- a/src/OpenFOAM/db/IOstreams/hashes/base64Layer.H +++ b/src/OpenFOAM/db/IOstreams/hashes/base64Layer.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - base64Layer + Foam::base64Layer Description An output filter layer to write base-64 encoded content. diff --git a/src/OpenFOAM/primitives/strings/lists/stringListOps.H b/src/OpenFOAM/primitives/strings/lists/stringListOps.H index 57cfd8cc03..da27993a7e 100644 --- a/src/OpenFOAM/primitives/strings/lists/stringListOps.H +++ b/src/OpenFOAM/primitives/strings/lists/stringListOps.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -InNamspace +InNamespace Foam Description diff --git a/src/Pstream/mpi/allReduce.H b/src/Pstream/mpi/allReduce.H index 83e4f4c847..938a9c9b27 100644 --- a/src/Pstream/mpi/allReduce.H +++ b/src/Pstream/mpi/allReduce.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -InNamspace +InNamespace Foam Description diff --git a/src/finiteArea/fields/edgeFields/edgeFields.H b/src/finiteArea/fields/edgeFields/edgeFields.H index f61e67f31f..4f4502f3e7 100644 --- a/src/finiteArea/fields/edgeFields/edgeFields.H +++ b/src/finiteArea/fields/edgeFields/edgeFields.H @@ -24,7 +24,7 @@ License along with OpenFOAM. If not, see . Class - edgeFields + Foam::edgeFields Description Finite area edge fields diff --git a/src/finiteArea/fields/edgeFields/edgeFieldsFwd.H b/src/finiteArea/fields/edgeFields/edgeFieldsFwd.H index 716d852a8e..f74e8fcc9b 100644 --- a/src/finiteArea/fields/edgeFields/edgeFieldsFwd.H +++ b/src/finiteArea/fields/edgeFields/edgeFieldsFwd.H @@ -23,13 +23,11 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -Class - edgeFields +InNamespace + Foam Description - -SourceFiles - edgeFields.C + Forwards for edge field types \*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H index 31767113fe..62bf5065fa 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H @@ -45,9 +45,10 @@ Description except that no interpolation in time is supported. These should be located in the directory: + \verbatim \$FOAM_CASE/constant/boundaryData/\/points \$FOAM_CASE/constant/boundaryData/\/0/\{R|U|L\} - + \endverbatim Usage \table diff --git a/src/functionObjects/lagrangian/common/parcelSelectionDetail.H b/src/functionObjects/lagrangian/common/parcelSelectionDetail.H index 18d8a2c775..d9221be879 100644 --- a/src/functionObjects/lagrangian/common/parcelSelectionDetail.H +++ b/src/functionObjects/lagrangian/common/parcelSelectionDetail.H @@ -61,7 +61,7 @@ Description action subset; source field; field d; - accept (greater 1e-3) and (less 1e-3); + accept (greater 1e-5) and (less 1e-3); } } \endverbatim