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
@ -68,9 +68,9 @@ Usage
- \par -disablePatchGroups
Disable the default checking for keys being patchGroups
Note
changeDictionary has been superseded by foamDictionary
and is now deprecated.
Note:
changeDictionary has been superseded by foamDictionary
and is now deprecated.
\*---------------------------------------------------------------------------*/