Documentation: Updated for Doxygen 1.11.0

Typos in documentation strings corrected with the aid of codespell
This commit is contained in:
Henry Weller
2024-07-06 10:32:56 +01:00
parent 5405cb9375
commit 5babe5c67c
60 changed files with 122 additions and 121 deletions

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -211,7 +211,7 @@ int main(int argc, char *argv[])
runTime.name(),
runTime
),
clone(mesh.points()), // could we safely re-use the data?
clone(mesh.points()), // could we safely reuse the data?
clone(mesh.faces()),
clone(mesh.cells())
);

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -111,7 +111,7 @@ cellShape extrudedQuadCellShape
// Create a label list for the model
// This is done by finding two edges that do not share any vertices.
// Knowing the opposite pair of edges (with normals poining outward
// Knowing the opposite pair of edges (with normals pointing outward
// is enough to make a cell
if
(

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -47,7 +47,7 @@ void Foam::sammMesh::writeMesh()
runTime_.constant(),
runTime_
),
clone(points_), // we could probably re-use the data
clone(points_), // we could probably reuse the data
cellShapes_,
boundary_,
patchNames_,
@ -78,7 +78,7 @@ void Foam::sammMesh::writeMesh()
runTime_.constant(),
runTime_
),
move(points_), // we could probably re-use the data
move(points_), // we could probably reuse the data
move(meshFaces_),
move(cellPolys_)
);

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -51,7 +51,7 @@ void Foam::starMesh::writeMesh()
runTime_.constant(),
runTime_
),
clone(points_), // we could probably re-use the data
clone(points_), // we could probably reuse the data
cellShapes_,
boundary_,
patchNames_,
@ -84,7 +84,7 @@ void Foam::starMesh::writeMesh()
runTime_.constant(),
runTime_
),
clone(points_), // we could probably re-use the data
clone(points_), // we could probably reuse the data
clone(meshFaces_),
clone(cellPolys_)
);

View File

@ -216,7 +216,7 @@ int main(int argc, char *argv[])
runTime.constant(),
runTime
),
clone(blocks.points()), // could we re-use space?
clone(blocks.points()), // could we reuse space?
blocks.cells(),
blocks.patches(),
blocks.patchNames(),

View File

@ -28,7 +28,7 @@ Description
Utility to create non-conformal couples between non-coupled patches.
Usage
\b createNonConformalCouples <patch1> <patch2>
\b createNonConformalCouples \<patch1\> \<patch2\>
Options:
- \par -overwrite \n