diff --git a/bin/doxyScr b/bin/doxyScr
index 1eb0e9a3c5ad3141860de97218d483f4afe2999f..3debc9865d1712d21a51c4d30abefca3c5131ecf 100644
--- a/bin/doxyScr
+++ b/bin/doxyScr
@@ -8,40 +8,52 @@ s?^License.*?\*\/\
}
# remove entry
-/^Primitive/{
+/^Primitive *$/{
N
N
d
}
# remove entry
-/^Implementation/{
+/^Implementation *$/{
N
N
d
}
# remove entry
-/^Application/{
+/^Application *$/{
N
N
d
}
# remove entry
-/^Type/{
+/^Type *$/{
N
N
d
}
# remove entry
-/^Global/{
+/^Global *$/{
N
N
d
}
+
+# Class
+# Foam::className
+# =>
+# @class Foam::className
+#
+/^Class *$/,/^[^ ]/{
+/^Class/d
+s/^ /@class /
+}
+
+
# Namespace
# namespaceName
# =>
@@ -53,14 +65,14 @@ s/^ /@namespace /
}
-# Class
-# Foam::className
+# Typedef
+# Foam::def
# =>
-# @class Foam::className
+# @typedef Foam::def
#
-/^Class *$/,/^[^ ]/{
-/^Class/d
-s/^ /@class /
+/^Typedef *$/,/^[^ ]/{
+/^Typedef/d
+s/^ /@typedef /
}
diff --git a/doc/Doxygen/Doxygen.css.save b/doc/Doxygen/Doxygen.css.save
deleted file mode 100644
index 8ddf229162edfdf3671d286ec27275f435dd1f16..0000000000000000000000000000000000000000
--- a/doc/Doxygen/Doxygen.css.save
+++ /dev/null
@@ -1,57 +0,0 @@
-body { color: #000000 ; background: #ffffff; margin: 0px; font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; font-size: 12px; }
-a:link { text-decoration: none; color: #0000ff ; }
-a:link:hover { text-decoration: none; color: #0000ff ; }
-a:visited { text-decoration: none; color: #0000ff ; }
-a:visited:hover { text-decoration: none; color: #0000ff ; }
-a:link img { border: 0; }
-a:visited img { border: 0; }
-a:active img { border: 0; }
-a.menuLefton { color: #0000ff; font-size: 12px; font-weight: bold; }
-td.leftmenu { font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; background: #ddddff; text-align: left; font-size: 14px; height: 20px; width: 200px; }
-a.menuTopoff { color: #000000; font-size: 14px; }
-a.menuTopoff:visited { color: #000000; font-size: 14px; }
-a.menuTopoff:hover { color: #0000ff; font-size: 14px; }
-td.topmenu { font-family: verdana, arial, helvetica, sans-serif; background: #ddddff; text-align: center; font-size: 16px; width: 150px; font-weight: bold; }
-h1 { font-size: 18px; }
-h2 { font-size: 16px; }
-h3 { font-size: 14px; }
-
-/* formatting for member functions:
- * Since the OpenFOAM code already has nice line-breaks, wrapping the lines
- * just looks terrible.
- * Give a slightly different background to make it easier to find.
-*/
-.memitem {
- padding: 4px;
- background-color: #eef3f5;
- border-width: 1px;
- border-style: solid;
- border-color: #dedeee;
-}
-
-.memproto {
- background-color: #d5e1e8;
- width: 100%;
- border-width: 1px;
- border-style: solid;
- border-color: #84b0c7;
- font-weight: bold;
-}
-
-table.memname {
- width: 100%;
- background: #f7f7ff;
- white-space: nowrap;
-}
-
-.mdescLeft {
- margin: 0px;
-}
-
-.mdescRight {
- font-style: italic;
-}
-
-.paramkey {
- width: 5%;
-}
\ No newline at end of file
diff --git a/doc/Doxygen/tools/README b/doc/Doxygen/tools/README
index 1bfc57fcdb73ed86f7a8e3edaf8b458257e883db..0a3a9ceecbdebda2b4685489d2c8a458f56af78a 100644
--- a/doc/Doxygen/tools/README
+++ b/doc/Doxygen/tools/README
@@ -5,6 +5,7 @@ See the comments in the scripts.
2. fix-Class
3. find-tinyDescription
4. find-placeholderDescription
+5. find-retagged
Misc Tools
1. find-templateInComments
diff --git a/doc/Doxygen/tools/find-its b/doc/Doxygen/tools/find-its
index 79e28eec02792abdc36581d3a0f281f7336e1478..2276183628256053140cfe5a44137fe187b08847 100755
--- a/doc/Doxygen/tools/find-its
+++ b/doc/Doxygen/tools/find-its
@@ -39,7 +39,6 @@ sub wanted {
close ARGV;
}
-
## Traverse desired filesystems
for my $dir (@ARGV) {
no warnings 'File::Find';
diff --git a/doc/Doxygen/tools/find-placeholderDescription b/doc/Doxygen/tools/find-placeholderDescription
index bb85dbf094136aed78fbfe943d7086f68f8f8a22..d22fe5f72f832f6ebd76539c29fbaee42377d6aa 100755
--- a/doc/Doxygen/tools/find-placeholderDescription
+++ b/doc/Doxygen/tools/find-placeholderDescription
@@ -8,7 +8,7 @@ use File::Find ();
# find-placeholderDescription
#
# Description
-# Search for *.[H] files with a Description that looks like it is
+# Search for *.[H] files with a Description that looks like it is
# a placeholder
# eg, Foam::className
#
@@ -30,21 +30,21 @@ sub wanted {
return;
}
- my ( $currentClass, $description );
+ my ( $tag, $description );
local @ARGV = $_;
while (<>) {
my $name;
- ## examine the class name
- if (/^Class\s*$/) {
+ ## examine the class/typedef name
+ if (/^(Class|Typedef)\s*$/) {
$_ = <>;
- ($currentClass) = split;
+ ($tag) = split;
}
if (/^Description\s*$/) {
$_ = <>;
( $description = $_ ) =~ s{^\s+|\s+$}{}g;
-
+
# remove trailing punctuation as being noise
$description =~ s{\s*[.,:]+$}{};
last;
@@ -53,13 +53,13 @@ sub wanted {
$description ||= '';
- ## we have 'Class' tag
- if ( defined $currentClass ) {
+ ## we have 'Class/Typedef' tag
+ if ( defined $tag ) {
# description looks like a class name
if (
$description =~ m{^\w+(::\w+)+$}
- ) {
- print "$File::Find::name # $description\n";
+ ) {
+ print "$File::Find::name # $description\n";
}
}
}
diff --git a/doc/Doxygen/tools/find-retagged b/doc/Doxygen/tools/find-retagged
new file mode 100755
index 0000000000000000000000000000000000000000..bde54a1b9df98e8c30355c7eacb0bcb9044b2da6
--- /dev/null
+++ b/doc/Doxygen/tools/find-retagged
@@ -0,0 +1,48 @@
+#!/usr/bin/perl -w
+use strict;
+use File::Find ();
+
+# -----------------------------------------------------------------------------
+#
+# Script
+# find-retagged
+#
+# Description
+# Search for *.[H] files with 'InClass', 'InNamespace' or 'Type'
+# starting in the first column.
+# In some places these could removed. In other places they should be
+# replaced with a 'Typedef'
+# - print filename and the tag (InClass|InNamespace|Type)
+#
+# -----------------------------------------------------------------------------
+
+my $re_filespec = qr{^.+\.[H]$};
+
+# for the convenience of &wanted calls, including -eval statements:
+## use vars qw( *name *dir *prune );
+## *name = *File::Find::name;
+## *dir = *File::Find::dir;
+## *prune = *File::Find::prune;
+
+sub wanted {
+ unless ( lstat($_) and -f _ and -r _ and not -l _ and /$re_filespec/ ) {
+ return;
+ }
+
+ local @ARGV = $_;
+ while (<>) {
+ if (/^(InClass|InNamespace|Type)\s*$/) {
+ print "$File::Find::name $1 line=$.\n";
+ }
+ }
+
+ close ARGV;
+}
+
+## Traverse desired filesystems
+for my $dir (@ARGV) {
+ no warnings 'File::Find';
+ warn "(**) checking '$dir' ...\n";
+ File::Find::find( { wanted => \&wanted }, $dir );
+}
+
diff --git a/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H b/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
index 667fb5ed1c25d1b0201ca4e533ed7cd4955ae67e..b284b1a271bcbb8c8178ec2017999d726926ba54 100644
--- a/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
+++ b/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
@@ -28,7 +28,7 @@ Class
Description
A HashTable with word keys but without contents.
-Class
+Typedef
Foam::wordHashSet
Description
diff --git a/src/OpenFOAM/containers/HashTables/labelHashSet/labelHashSet.H b/src/OpenFOAM/containers/HashTables/labelHashSet/labelHashSet.H
index a9c5b7ad152ed6714dd0de946785552bedd85651..f55c50152d84e931ec6ac9d2e4a699025f1e1093 100644
--- a/src/OpenFOAM/containers/HashTables/labelHashSet/labelHashSet.H
+++ b/src/OpenFOAM/containers/HashTables/labelHashSet/labelHashSet.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Class
+Typedef
Foam::labelHashSet
Description
diff --git a/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H b/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H
index 6bef420cf3dafe9906eb91917104bd95a7d97ff9..c058b3992f8503e65353e7b4ae7a88dfaa71eba3 100644
--- a/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H
+++ b/src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H
@@ -26,14 +26,14 @@ Class
Foam::IOstream
Description
- An IOstream is an abstract base class for all input/output
- systems; be they streams, files, token lists etc.
- The basic operations are construct, close, read token,
- read primitive and read binary block. In addition version control
- and line number counting is incorporated. Usually one would use
- the read primitive member functions, but if one were reading a
- stream on unknown data sequence one can read token by token, and
- then analyse.
+ An IOstream is an abstract base class for all input/output systems; be
+ they streams, files, token lists etc.
+
+ The basic operations are construct, close, read token, read primitive
+ and read binary block. In addition version control and line number
+ counting is incorporated. Usually one would use the read primitive
+ member functions, but if one were reading a stream on unknown data
+ sequence one can read token by token, and then analyse.
SourceFiles
IOprint.C
diff --git a/src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H b/src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H
index b2c28b3d50352b5a39b48cef4cc111db4a2a8f4d..941583bd979ef9559f0b432244dd0f06309bdb22 100644
--- a/src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H
+++ b/src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H
@@ -154,7 +154,7 @@ public:
//- Flush stream
virtual void flush() = 0;
- //- Add '\n' and flush stream
+ //- Add newline and flush stream
virtual void endl() = 0;
//- Get width of output field
@@ -233,7 +233,7 @@ inline Ostream& flush(Ostream& os)
}
-//- Add '\n' and flush stream
+//- Add newline and flush stream
inline Ostream& endl(Ostream& os)
{
os.endl();
diff --git a/src/OpenFOAM/fields/Fields/complexFields/complexFields.H b/src/OpenFOAM/fields/Fields/complexFields/complexFields.H
index 0a24f3cb3832fbd16a7f1f6701b42942adfc8a6d..6cd3ffcaa6d225a5216d27837e4ad76f13ed7a3e 100644
--- a/src/OpenFOAM/fields/Fields/complexFields/complexFields.H
+++ b/src/OpenFOAM/fields/Fields/complexFields/complexFields.H
@@ -22,11 +22,17 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::complexFields
+Typedef
+ Foam::complexField
Description
- Specialisation of Field\<T\> for complex and complexVector.
+ Specialisation of Field\<T\> for complex.
+
+Typedef
+ Foam::complexVectorField
+
+Description
+ Specialisation of Field\<T\> for complexVector.
SourceFiles
complexFields.C
diff --git a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorField.H b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorField.H
index 26b4f5bea3a46f648163cc7a554a91947b48b30d..29e7a840638079530fb20f8f4a66c1999ff1d03b 100644
--- a/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorField.H
+++ b/src/OpenFOAM/fields/Fields/diagTensorField/diagTensorField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::diagTensorField
Description
diff --git a/src/OpenFOAM/fields/Fields/labelField/labelField.H b/src/OpenFOAM/fields/Fields/labelField/labelField.H
index 5f26e340732b25cf93149f558c3ecb27502e6541..20fe4cb75d850d6f29f14b27f575086c91e76e9f 100644
--- a/src/OpenFOAM/fields/Fields/labelField/labelField.H
+++ b/src/OpenFOAM/fields/Fields/labelField/labelField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::labelField
Description
diff --git a/src/OpenFOAM/fields/Fields/scalarField/scalarField.H b/src/OpenFOAM/fields/Fields/scalarField/scalarField.H
index 359fc78bfe92be33c8db1affa5ec96e5da3bd629..4c8f317daebce15d852d9a19ea7004f666d77e95 100644
--- a/src/OpenFOAM/fields/Fields/scalarField/scalarField.H
+++ b/src/OpenFOAM/fields/Fields/scalarField/scalarField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::scalarField
Description
diff --git a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorField.H b/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorField.H
index 90100e66bfbc5df709bb2ca7516e8a162f2d6d91..b5bbfba510e26605f6ef27de97e7f51aaf52386c 100644
--- a/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorField.H
+++ b/src/OpenFOAM/fields/Fields/sphericalTensorField/sphericalTensorField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::sphericalTensorField
Description
diff --git a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorField.H b/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorField.H
index cb6a07192857d23c5134521511193708cff7e3bd..645a371826c0e0b461927cf6c6de14f29333e64c 100644
--- a/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorField.H
+++ b/src/OpenFOAM/fields/Fields/symmTensorField/symmTensorField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::symmTensorField
Description
diff --git a/src/OpenFOAM/fields/Fields/symmTransformField/symmTransformField.H b/src/OpenFOAM/fields/Fields/symmTransformField/symmTransformField.H
index 1733b61d188854c8b0eef076bb04189b6e6cc18e..52a400b138ebe4bf8217b731a9b26abd75d9aa53 100644
--- a/src/OpenFOAM/fields/Fields/symmTransformField/symmTransformField.H
+++ b/src/OpenFOAM/fields/Fields/symmTransformField/symmTransformField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::symmTransformField
Description
diff --git a/src/OpenFOAM/fields/Fields/tensorField/tensorField.H b/src/OpenFOAM/fields/Fields/tensorField/tensorField.H
index 239b5acd54209774d96efd1db3128b8b05a9964d..6d55b768d538faefa0743cafb7bea9502f7bb8df 100644
--- a/src/OpenFOAM/fields/Fields/tensorField/tensorField.H
+++ b/src/OpenFOAM/fields/Fields/tensorField/tensorField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::tensorField
Description
diff --git a/src/OpenFOAM/fields/Fields/vector2DField/vector2DField.H b/src/OpenFOAM/fields/Fields/vector2DField/vector2DField.H
index 1c5c0c21099d28f600dbb71f865d503452bde1de..c9ed77c29e6ce70623701f9f4b97830bf70cde73 100644
--- a/src/OpenFOAM/fields/Fields/vector2DField/vector2DField.H
+++ b/src/OpenFOAM/fields/Fields/vector2DField/vector2DField.H
@@ -22,11 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::vector2DField
-
Description
- Specialisation of Field\<T\> for vector2D.
+ Foam::vector2DField
SourceFiles
vector2DField.C
diff --git a/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldFwd.H b/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldFwd.H
index d60444bbd2aeb0f0ce97230e6362fe6a2f5849a5..e2f1f5e54fd9314d03e615a086730517e6a11ac1 100644
--- a/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldFwd.H
+++ b/src/OpenFOAM/fields/Fields/vector2DField/vector2DFieldFwd.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::vector2DField
Description
diff --git a/src/OpenFOAM/fields/Fields/vectorField/vectorField.H b/src/OpenFOAM/fields/Fields/vectorField/vectorField.H
index 4b43354e67b107bcff059c372d76e2bd24cb1589..74ba87defff91391db87d85181dfacc3cc6443f7 100644
--- a/src/OpenFOAM/fields/Fields/vectorField/vectorField.H
+++ b/src/OpenFOAM/fields/Fields/vectorField/vectorField.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::vectorField
Description
diff --git a/src/OpenFOAM/interpolations/primitivePatchInterpolation/primitivePatchInterpolation.H b/src/OpenFOAM/interpolations/primitivePatchInterpolation/primitivePatchInterpolation.H
index 680aacc4a090707bc51f48fc3b3304d6632be51d..e8787c6ee7421580a2cd2481b3f394852d2e2465 100644
--- a/src/OpenFOAM/interpolations/primitivePatchInterpolation/primitivePatchInterpolation.H
+++ b/src/OpenFOAM/interpolations/primitivePatchInterpolation/primitivePatchInterpolation.H
@@ -22,10 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::primitivePatchInterpolation
Description
+ Foam::primitivePatchInterpolation
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H b/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H
index 7a0bc52f599d3e9c22ec0d8aa94b3e5a71cd1c57..7284481c93707539d8174812a861c28a0b3f9162 100644
--- a/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H
+++ b/src/OpenFOAM/meshes/meshShapes/edge/edgeIOList.H
@@ -22,11 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::edgeIOList
Description
- IOList of edges
+ An IOList of edges
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneIDs.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneIDs.H
index 290cbb900f79f5727c15ecbd88d49b18028ac5df..5cfa77a806dcaf5f2b338d07584b6ed3e76b6b87 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneIDs.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneIDs.H
@@ -22,11 +22,6 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::ZoneID
-
-Description
-
\*---------------------------------------------------------------------------*/
#ifndef ZoneIDs_H
@@ -41,8 +36,11 @@ Description
namespace Foam
{
+ //- Foam::pointZoneID
typedef ZoneID<pointZone> pointZoneID;
+ //- Foam::faceZoneID
typedef ZoneID<faceZone> faceZoneID;
+ //- Foam::cellZoneID
typedef ZoneID<cellZone> cellZoneID;
}
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/cellZoneMesh.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/cellZoneMesh.H
index c0ae06c760fb9a25aac4c70a89efe2878526cff7..c5e279af5447ae69412388f3ada35f0f6d008096 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/cellZoneMesh.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/cellZoneMesh.H
@@ -22,10 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::cellZoneMesh
-
Description
+ Foam::cellZoneMesh
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/faceZoneMesh.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/faceZoneMesh.H
index cafa435e896df5c5c045b1b4cb3048de786b3e53..2d88a9e5cf78830f516852065e354ac56a99779a 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/faceZoneMesh.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/faceZoneMesh.H
@@ -22,10 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::faceZoneMesh
-
Description
+ Foam::faceZoneMesh
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/pointZoneMesh.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/pointZoneMesh.H
index dff38f22cde057382fc0e4907486a4d2eb90f725..c82d1cecf348e47f6e0701837d760c6688fa2c6b 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/pointZoneMesh.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/pointZoneMesh.H
@@ -22,10 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::pointZoneMesh
-
Description
+ Foam::pointZoneMesh
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/indirectPrimitivePatch.H b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/indirectPrimitivePatch.H
index 9d71ccc374edb98685a79ce89d86500aa97e77c8..65e4d691848ccc9647099ef2705eb1dab61c9f0b 100644
--- a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/indirectPrimitivePatch.H
+++ b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/indirectPrimitivePatch.H
@@ -22,10 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::indirectPrimitivePatch
Description
+ Foam::indirectPrimitivePatch
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitiveFacePatch.H b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitiveFacePatch.H
index a16092b945f25b4dc00f331499f62f202a6f73f6..fcfd795d213deb39cb07cbffa46d4fe361ff1dfa 100644
--- a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitiveFacePatch.H
+++ b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitiveFacePatch.H
@@ -22,10 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::primitiveFacePatch
Description
+ Foam::primitiveFacePatch
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitivePatch.H b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitivePatch.H
index 340454b5819ff48cb172678fe79f7ceee88ade2a..2fdab9e61d95a06081e81537a78132802b4772a7 100644
--- a/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitivePatch.H
+++ b/src/OpenFOAM/meshes/primitiveMesh/primitivePatch/primitivePatch.H
@@ -22,10 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::primitivePatch
Description
+ Foam::primitivePatch
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/primitives/Scalar/doubleScalar/doubleScalar.H b/src/OpenFOAM/primitives/Scalar/doubleScalar/doubleScalar.H
index 6f6f293d5638a0a3da6df93f365fa1b33ff3e446..3aa56878575b9952677065b65f45792c001b4ea0 100644
--- a/src/OpenFOAM/primitives/Scalar/doubleScalar/doubleScalar.H
+++ b/src/OpenFOAM/primitives/Scalar/doubleScalar/doubleScalar.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::doubleScalar
Description
diff --git a/src/OpenFOAM/primitives/Scalar/floatScalar/floatScalar.H b/src/OpenFOAM/primitives/Scalar/floatScalar/floatScalar.H
index d52fd0d621bd402d87d22793a379678b4c8d9d80..35c9c32f648c3099cc6e4e834815aa6fad1875b8 100644
--- a/src/OpenFOAM/primitives/Scalar/floatScalar/floatScalar.H
+++ b/src/OpenFOAM/primitives/Scalar/floatScalar/floatScalar.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::floatScalar
Description
diff --git a/src/OpenFOAM/primitives/contiguous/contiguous.H b/src/OpenFOAM/primitives/contiguous/contiguous.H
index 71af0e3dfd35179652e8cc0b7a93aa84b448bdda..61f3042496e53de0bd2c70e6e413cecf8ea22d0e 100644
--- a/src/OpenFOAM/primitives/contiguous/contiguous.H
+++ b/src/OpenFOAM/primitives/contiguous/contiguous.H
@@ -26,9 +26,12 @@ InClass
Foam::contiguous
Description
- Template fuction which specifies if the data of the type is contiguous
- or not. The default function specifies not and this is specialised for
- the types (e.g. primitives) for which their data is contiguous.
+ Template function which specifies if the data of the type is contiguous
+ or not.
+
+ The default function specifies that data are not contiguous.
+ This is specialised for the types (e.g. primitives) for which their
+ data are contiguous.
\*---------------------------------------------------------------------------*/
diff --git a/src/dynamicMesh/boundaryMesh/bMesh.H b/src/dynamicMesh/boundaryMesh/bMesh.H
index 5b4821f8ea8561fa2465a4d7f2c357677982002c..f2c57e759ea7cab201ec8d8a42fc8bd10c84facb 100644
--- a/src/dynamicMesh/boundaryMesh/bMesh.H
+++ b/src/dynamicMesh/boundaryMesh/bMesh.H
@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
+Typedef
Foam::bMesh
Description
diff --git a/src/lagrangian/dieselSpray/sprayThermoTypes/sprayThermoTypes.H b/src/lagrangian/dieselSpray/sprayThermoTypes/sprayThermoTypes.H
index 88b4aca8e1f8027e97da3d716a95f29fd58c19f2..9387198031829467265f1b17a4121a71a7921ea5 100644
--- a/src/lagrangian/dieselSpray/sprayThermoTypes/sprayThermoTypes.H
+++ b/src/lagrangian/dieselSpray/sprayThermoTypes/sprayThermoTypes.H
@@ -22,10 +22,11 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::sprayThermoTypes
+Typedef
+ Foam::specieProperties
Description
+ Foam::specieProperties
\*---------------------------------------------------------------------------*/
@@ -44,7 +45,7 @@ namespace Foam
typedef sutherlandTransport<specieThermo<janafThermo<perfectGas> > >
specieProperties;
- //typedef sutherlandTransport<specieThermo<hConstThermo<perfectGas> > >
+ // typedef sutherlandTransport<specieThermo<hConstThermo<perfectGas> > >
// specieProperties;
}
diff --git a/src/lagrangian/intermediate/IntegrationScheme/IntegrationScheme/IntegrationSchemesFwd.H b/src/lagrangian/intermediate/IntegrationScheme/IntegrationScheme/IntegrationSchemesFwd.H
index 63e4a07997d108b1e1111cbb97568cce1f03f6b9..c3581a3c0c1a7f7e9c29c442c7ca5062d6609151 100644
--- a/src/lagrangian/intermediate/IntegrationScheme/IntegrationScheme/IntegrationSchemesFwd.H
+++ b/src/lagrangian/intermediate/IntegrationScheme/IntegrationScheme/IntegrationSchemesFwd.H
@@ -22,10 +22,17 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-InClass
- Foam::IntegrationScheme
+Typedef
+ Foam::scalarIntegrationScheme
Description
+ Foam::scalarIntegrationScheme
+
+Typedef
+ Foam::vectorIntegrationScheme;
+
+Description
+ Foam::vectorIntegrationScheme;
SourceFiles
IntegrationScheme.C
diff --git a/src/meshTools/octree/treeBoundBox.C b/src/meshTools/octree/treeBoundBox.C
index 0842d4ed6be48b8768212576c6e8dfba68982c6e..e3972f3a26bcc814b58e3375d58de61878c050ee 100644
--- a/src/meshTools/octree/treeBoundBox.C
+++ b/src/meshTools/octree/treeBoundBox.C
@@ -29,19 +29,17 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-namespace Foam
-{
-
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
-const treeBoundBox treeBoundBox::greatBox
+const Foam::treeBoundBox Foam::treeBoundBox::greatBox
(
vector(-GREAT, -GREAT, -GREAT),
vector(GREAT, GREAT, GREAT)
);
-const label facesArray[6][4] =
+//! @cond - skip documentation : local scope only
+const Foam::label facesArray[6][4] =
{
{0, 4, 6, 2}, // left
{1, 3, 7, 5}, // right
@@ -50,25 +48,33 @@ const label facesArray[6][4] =
{0, 2, 3, 1}, // back
{4, 5, 7, 6} // front
};
-const faceList treeBoundBox::faces(initListList<face, label, 6, 4>(facesArray));
+//! @endcond
+
+const Foam::faceList Foam::treeBoundBox::faces
+(
+ initListList<face, label, 6, 4>(facesArray)
+);
-const label edgesArray[12][2] =
+//! @cond - skip documentation : local scope only
+const Foam::label edgesArray[12][2] =
{
- {0, 1}, //0
+ {0, 1}, // 0
{1, 3},
- {2, 3}, //2
+ {2, 3}, // 2
{0, 2},
- {4, 5}, //4
+ {4, 5}, // 4
{5, 7},
- {6, 7}, //6
+ {6, 7}, // 6
{4, 6},
- {0, 4}, //8
+ {0, 4}, // 8
{1, 5},
- {3, 7}, //10
+ {3, 7}, // 10
{2, 6}
};
-const edgeList treeBoundBox::edges
+//! @endcond
+
+const Foam::edgeList Foam::treeBoundBox::edges
(
initListList<edge, label, 12, 2>(edgesArray)
);
@@ -77,7 +83,7 @@ const edgeList treeBoundBox::edges
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
// Construct as the bounding box of the given pointField
-treeBoundBox::treeBoundBox(const UList<point>& points)
+Foam::treeBoundBox::treeBoundBox(const UList<point>& points)
:
boundBox()
{
@@ -102,7 +108,7 @@ treeBoundBox::treeBoundBox(const UList<point>& points)
// Construct as the bounding box of the given pointField
-treeBoundBox::treeBoundBox
+Foam::treeBoundBox::treeBoundBox
(
const UList<point>& points,
const labelList& meshPoints
@@ -133,7 +139,7 @@ treeBoundBox::treeBoundBox
// Construct from Istream
-treeBoundBox::treeBoundBox(Istream& is)
+Foam::treeBoundBox::treeBoundBox(Istream& is)
:
boundBox(is)
{}
@@ -141,7 +147,7 @@ treeBoundBox::treeBoundBox(Istream& is)
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
-pointField treeBoundBox::points() const
+Foam::pointField Foam::treeBoundBox::points() const
{
pointField points(8);
forAll(points, octant)
@@ -153,7 +159,7 @@ pointField treeBoundBox::points() const
}
-treeBoundBox treeBoundBox::subBbox(const direction octant) const
+Foam::treeBoundBox Foam::treeBoundBox::subBbox(const direction octant) const
{
if (octant > 7)
{
@@ -216,8 +222,11 @@ treeBoundBox treeBoundBox::subBbox(const direction octant) const
// Octant to bounding box using permutation only.
-treeBoundBox treeBoundBox::subBbox(const point& mid, const direction octant)
- const
+Foam::treeBoundBox Foam::treeBoundBox::subBbox
+(
+ const point& mid,
+ const direction octant
+) const
{
if (octant > 7)
{
@@ -285,7 +294,7 @@ treeBoundBox treeBoundBox::subBbox(const point& mid, const direction octant)
// - sets coordinate to exact position: e.g. pt.x() = min().x()
// since plane intersect routine might have truncation error.
// This makes sure that posBits tests 'inside'
-bool treeBoundBox::intersects
+bool Foam::treeBoundBox::intersects
(
const point& start,
const point& end,
@@ -387,13 +396,13 @@ bool treeBoundBox::intersects
// this.bb fully contains bb
-bool treeBoundBox::contains(const treeBoundBox& bb) const
+bool Foam::treeBoundBox::contains(const treeBoundBox& bb) const
{
return contains(bb.min()) && contains(bb.max());
}
-bool treeBoundBox::containsNarrow(const point& sample) const
+bool Foam::treeBoundBox::containsNarrow(const point& sample) const
{
return
(
@@ -406,7 +415,7 @@ bool treeBoundBox::containsNarrow(const point& sample) const
);
}
-bool treeBoundBox::contains(const vector& dir, const point& sample) const
+bool Foam::treeBoundBox::contains(const vector& dir, const point& sample) const
{
//
// Compare all components against min and max of bb
@@ -447,7 +456,7 @@ bool treeBoundBox::contains(const vector& dir, const point& sample) const
// Code position of point relative to box
-direction treeBoundBox::posBits(const point& pt) const
+Foam::direction Foam::treeBoundBox::posBits(const point& pt) const
{
direction posBits = 0;
@@ -483,7 +492,7 @@ direction treeBoundBox::posBits(const point& pt) const
// nearest and furthest corner coordinate.
// !names of treeBoundBox::min() and treeBoundBox::max() are confusing!
-void treeBoundBox::calcExtremities
+void Foam::treeBoundBox::calcExtremities
(
const point& sample,
point& nearest,
@@ -531,7 +540,7 @@ void treeBoundBox::calcExtremities
}
-scalar treeBoundBox::maxDist(const point& sample) const
+Foam::scalar Foam::treeBoundBox::maxDist(const point& sample) const
{
point near, far;
calcExtremities(sample, near, far);
@@ -543,7 +552,7 @@ scalar treeBoundBox::maxDist(const point& sample) const
// Distance comparator
// Compare all vertices of bounding box against all of other bounding
// box to see if all vertices of one are nearer
-label treeBoundBox::distanceCmp
+Foam::label Foam::treeBoundBox::distanceCmp
(
const point& sample,
const treeBoundBox& other
@@ -622,15 +631,11 @@ bool operator!=(const treeBoundBox& a, const treeBoundBox& b)
// * * * * * * * * * * * * * * * IOstream Operator * * * * * * * * * * * * * //
-Istream& operator>>(Istream& is, treeBoundBox& bb)
+Foam::Istream& Foam::operator>>(Istream& is, treeBoundBox& bb)
{
is >> bb.min() >> bb.max();
return is;
}
-// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
-} // End namespace Foam
-
// ************************************************************************* //