Documentation: Moved "Notes" entries into the corresponding "Description" or "Usage"

This simplifies parsing the headers and ensures the notes are included in the
text they relate to by both Doxygen and foamInfo.
This commit is contained in:
Henry Weller
2022-05-12 09:51:14 +01:00
parent 03211cda95
commit 137a40ef56
97 changed files with 470 additions and 488 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-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,9 +49,10 @@ Usage
- \par -cellZone zoneName
Specify single cellZone to write (not lagrangian)
Note
Parallel support for cloud data is not supported
- writes to \a EnSight directory to avoid collisions with foamToEnsightParts
Note:
Parallel support for cloud data is not supported
- writes to \a EnSight directory to avoid collisions with
foamToEnsightParts
\*---------------------------------------------------------------------------*/