Updated documentation for foamInfo: The "Note" entry is now part of "Description" or "Usage"

so that it is printed by foamInfo.
This commit is contained in:
Henry Weller
2022-05-11 21:27:27 +01:00
parent 7a8f59e2b9
commit 48d9c77085
28 changed files with 147 additions and 147 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) 2013-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,9 +45,9 @@ Usage
phase | phase name | no |
\endtable
Note
Writing field 'yPlus' is done by default, but it can be overridden by
defining an empty \c objects list. For details see writeLocalObjects.
Note:
Writing field 'yPlus' is done by default, but it can be overridden by
defining an empty \c objects list. For details see writeLocalObjects.
See also
Foam::functionObject