zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: fix some doxygen markup

Browse Source 
- missing verbatim/endverbatim markers, missing "Foam::" prefix, typos
This commit is contained in:
Mark Olesen
2019-01-11 08:22:02 +01:00
parent 030877f8af
commit cb5617e070
14 changed files with 19 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/utilities/parallelProcessing/decomposePar/faFieldDecomposer.H
View File

@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
faFieldDecomposer
Foam::faFieldDecomposer
Description
Finite Area area and edge field decomposer.

2
applications/utilities/parallelProcessing/decomposePar/faMeshDecomposition.H
View File

@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
faMeshDecomposition
Foam::faMeshDecomposition
Description
Automatic faMesh decomposition class

5
applications/utilities/parallelProcessing/reconstructPar/faFieldReconstructor.H
View File

@ -24,10 +24,10 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
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
\*---------------------------------------------------------------------------*/

3
applications/utilities/parallelProcessing/reconstructPar/processorFaMeshes.H
View File

@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
processorFaMeshes
Foam::processorFaMeshes
Description
Container for processor mesh addressing.
@ -51,7 +51,6 @@ SourceFiles
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class processorFaMeshes Declaration
\*---------------------------------------------------------------------------*/

4
src/OpenFOAM/containers/HashTables/HashOps/HashOps.H
View File

@ -21,13 +21,13 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namspace
Namespace
Foam::HashSetOps
Description
Various operations for HashSet.
Namspace
Namespace
Foam::HashTableOps
Description

2
src/OpenFOAM/containers/HashTables/HashTableFwd.H
View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description

2
src/OpenFOAM/containers/Lists/ListOps/ListOps.H
View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description

2
src/OpenFOAM/db/IOstreams/hashes/base64Layer.H
View File

@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
base64Layer
Foam::base64Layer
Description
An output filter layer to write base-64 encoded content.

2
src/OpenFOAM/primitives/strings/lists/stringListOps.H
View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description

2
src/Pstream/mpi/allReduce.H
View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description

2
src/finiteArea/fields/edgeFields/edgeFields.H
View File

@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
edgeFields
Foam::edgeFields
Description
Finite area edge fields

8
src/finiteArea/fields/edgeFields/edgeFieldsFwd.H
View File

@ -23,13 +23,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
edgeFields
InNamespace
Foam
Description
SourceFiles
edgeFields.C
Forwards for edge field types
\*---------------------------------------------------------------------------*/

3
src/finiteVolume/fields/fvPatchFields/derived/turbulentDFSEMInlet/turbulentDFSEMInletFvPatchVectorField.H
View File

@ -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/\<patchName\>/points
\$FOAM_CASE/constant/boundaryData/\<patchName\>/0/\{R|U|L\}
\endverbatim
Usage
\table

2
src/functionObjects/lagrangian/common/parcelSelectionDetail.H
View File

@ -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