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:
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration | Website: https://openfoam.org
|
||||
\\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -37,9 +37,9 @@ Description
|
||||
the patch geometry (points and faces) for the coupled patches are output
|
||||
to the communications directory.
|
||||
|
||||
Note:
|
||||
The addressing is patch-local, i.e. point indices for each patch point
|
||||
used for face addressing starts at index 0.
|
||||
Note:
|
||||
The addressing is patch-local, i.e. point indices for each patch point
|
||||
used for face addressing starts at index 0.
|
||||
|
||||
See also
|
||||
externalCoupledMixedFvPatchField
|
||||
|
||||
Reference in New Issue
Block a user