Commit cb5617e0 authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: fix some doxygen markup

- missing verbatim/endverbatim markers, missing "Foam::" prefix, typos
parent 030877f8
......@@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
faFieldDecomposer
Foam::faFieldDecomposer
Description
Finite Area area and edge field decomposer.
......
......@@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
faMeshDecomposition
Foam::faMeshDecomposition
Description
Automatic faMesh decomposition class
......
......@@ -24,10 +24,10 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
faFieldReconstructor
Foam::faFieldReconstructor
Description
FA area and edge field reconstructor.
Finite Area area and edge fields reconstruction.
Author
Zeljko Tukovic, FSB Zagreb
......@@ -53,7 +53,6 @@ SourceFiles
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class faFieldReconstructor Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
processorFaMeshes
Foam::processorFaMeshes
Description
Container for processor mesh addressing.
......@@ -51,7 +51,6 @@ SourceFiles
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class processorFaMeshes Declaration
\*---------------------------------------------------------------------------*/
......
......@@ -21,13 +21,13 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namspace
Namespace
Foam::HashSetOps
Description
Various operations for HashSet.
Namspace
Namespace
Foam::HashTableOps
Description
......
......@@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description
......
......@@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
base64Layer
Foam::base64Layer
Description
An output filter layer to write base-64 encoded content.
......
......@@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description
......
......@@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamspace
InNamespace
Foam
Description
......
......@@ -24,7 +24,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
edgeFields
Foam::edgeFields
Description
Finite area edge fields
......
......@@ -23,13 +23,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
edgeFields
InNamespace
Foam
Description
SourceFiles
edgeFields.C
Forwards for edge field types
\*---------------------------------------------------------------------------*/
......
......@@ -45,9 +45,10 @@ Description
except that no interpolation in time is supported. These should be
located in the directory:
\verbatim
\$FOAM_CASE/constant/boundaryData/\<patchName\>/points
\$FOAM_CASE/constant/boundaryData/\<patchName\>/0/\{R|U|L\}
\endverbatim
Usage
\table
......
......@@ -61,7 +61,7 @@ Description
action subset;
source field;
field d;
accept (greater 1e-3) and (less 1e-3);
accept (greater 1e-5) and (less 1e-3);
}
}
\endverbatim
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment