From b3cde56f278ccd3833a09f12de0b4d3b704e8f13 Mon Sep 17 00:00:00 2001
From: Henry <Henry>
Date: Mon, 7 Feb 2011 22:50:49 +0000
Subject: [PATCH] Doxygen docs: Corrected doxyFilter to preserve line numbers
Also corrected many formatting errors in the comments in C and H files
---
.../phaseChangeTwoPhaseMixtures/Kunz/Kunz.H | 4 +-
.../Merkle/Merkle.H | 4 +-
.../SchnerrSauer/SchnerrSauer.H | 4 +-
.../extrudeToRegionMesh/extrudeToRegionMesh.C | 8 +-
bin/tools/doxyFilter | 4 +-
bin/tools/doxyFilter.awk | 6 +-
bin/tools/doxyFilter.sed | 111 ++++++++----------
doc/Doxygen/Doxyfile | 6 +-
doc/doxygen/Doxyfile | 5 +-
src/OSspecific/POSIX/fileMonitor.C | 24 ++--
.../addToGlobalFunctionSelectionTable.H | 9 +-
.../globalFunctionSelectionTables.H | 7 +-
.../addToStaticMemberFunctionSelectionTable.H | 6 +-
.../staticMemberFunctionSelectionTables.H | 7 +-
.../interpolationTable/interpolationTable.H | 4 +-
.../matrices/DiagonalMatrix/DiagonalMatrix.H | 4 +-
.../functions/DataEntry/Constant/Constant.H | 2 +-
.../functions/DataEntry/Table/Table.H | 2 +-
.../DataEntry/polynomial/polynomial.H | 2 +-
.../primitives/hashes/Hasher/HasherInt.H | 10 +-
.../general/porousMedia/PorousZones.H | 4 +-
src/finiteVolume/fvMesh/fvMesh.H | 14 ++-
.../surfaceInterpolation/surfaceInterpolate.H | 6 +-
src/lagrangian/basic/Cloud/Cloud.H | 2 +-
.../basic/addSubtract/addSubtract.H | 10 +-
.../mutkRoughWallFunctionFvPatchScalarField.H | 4 +-
.../LES/SpalartAllmaras/SpalartAllmaras.H | 4 +-
.../SpalartAllmarasDDES/SpalartAllmarasDDES.H | 4 +-
.../SpalartAllmarasIDDES.H | 4 +-
.../LES/kOmegaSSTSAS/kOmegaSSTSAS.H | 4 +-
30 files changed, 142 insertions(+), 143 deletions(-)
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H
index 03652fd9a77..2bb0db8e24f 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -39,7 +39,7 @@ Description
to Cavitation Prediction,â€
Computers and Fluids,
29(8):849-875, 2000.
- @verbatim
+ @endverbatim
SourceFiles
Kunz.C
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H
index d77447d5409..68e9c2871dc 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H
@@ -2,7 +2,7 @@
========Merkle= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -33,7 +33,7 @@ Description
"Computational modeling of the dynamics of sheet cavitation",
in Proceedings Third International Symposium on Cavitation
Grenoble, France 1998.
- @verbatim
+ @endverbatim
SourceFiles
Merkle.C
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H
index 87ac7e232d9..98d5d69a2c8 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H
+++ b/applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -33,7 +33,7 @@ Description
"Physical and Numerical Modeling of Unsteady Cavitation Dynamics",
Proc. 4th International Conference on Multiphase Flow,
New Orleans, U.S.A., 2001.
- @verbatim
+ @endverbatim
SourceFiles
SchnerrSauer.C
diff --git a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
index bd068c5b48b..e0f86f3f91b 100644
--- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -30,9 +30,9 @@ Description
- create baffles in original mesh with directMappedWall patches
- if extruding boundary faces:
- convert boundary faces to directMappedWall patches
- - extrude edges of faceZone as a <zone>_sidePatch
+ - extrude edges of faceZone as a \<zone\>_sidePatch
- extrude edges inbetween different faceZones as a
- (nonuniformTransform)cyclic <zoneA>_<zoneB>
+ (nonuniformTransform)cyclic \<zoneA\>_\<zoneB\>
- extrudes into master direction (i.e. away from the owner cell
if flipMap is false)
- not parallel
@@ -106,7 +106,7 @@ becomes
Usage
- - extrudeToRegionMesh <regionName> <faceZones> <thickness>
+ - extrudeToRegionMesh \<regionName\> \<faceZones\> \<thickness\>
@param \<regionName\> \n
Name of mesh to create.
diff --git a/bin/tools/doxyFilter b/bin/tools/doxyFilter
index af122f9c87f..4b1e35223eb 100755
--- a/bin/tools/doxyFilter
+++ b/bin/tools/doxyFilter
@@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+# \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# License
@@ -52,7 +52,7 @@ then
# */applications/solvers/*.H | */applications/utilities/*.H )
# awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-ignore.awk
# ;;
- esac
+ esac
awk -f $awkScript $1 | \
sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter.sed \
diff --git a/bin/tools/doxyFilter.awk b/bin/tools/doxyFilter.awk
index 85e57c75ec0..aebfbbaf31b 100644
--- a/bin/tools/doxyFilter.awk
+++ b/bin/tools/doxyFilter.awk
@@ -2,7 +2,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
-# \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+# \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
# \\/ M anipulation |
# -----------------------------------------------------------------------------
# License
@@ -57,7 +57,7 @@ BEGIN {
# start comment block
if (state == 1)
{
- printf "/*!\n"
+ printf "/*! "
state = 2
}
@@ -79,7 +79,7 @@ BEGIN {
# end comment block
if (state == 2)
{
- printf "*/\n"
+ printf "*/ "
}
state = 0
print
diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed
index 45a15019e13..681929a9047 100644
--- a/bin/tools/doxyFilter.sed
+++ b/bin/tools/doxyFilter.sed
@@ -11,147 +11,140 @@
/^License/,/\*\//{
/^License/,\%http://www.gnu.org/licenses%{
s?^License.*?\*\/\
-\/\*! @file %filePath%\
+\/\*! \\file %filePath%\
<b>Original source file</b> <a href="%filePath%">%fileName%</a>\
+\
+\
+\
+\
+\
+\
+\
+\
?
/^ /d
}
-# old FSF address
-/^License/,/MA 0211.-130. USA/{
-s?^License.*?\*\/\
-\/\*! @file %filePath%\
-<b>Original source file</b> <a href="%filePath%">%fileName%</a>\
-?
-/^ /d
-}
# remove entry
-/^Primitive *$/{
+/^Application *$/{
N
N
d
}
-# remove entry
-/^Implementation *$/{
-N
-N
-d
-}
# remove entry
-/^Application *$/{
+/^Global *$/{
N
N
d
}
-# remove entry
-/^Type *$/{
-N
-N
-d
-}
-# remove entry
-/^Global *$/{
-N
-N
-d
+# Primitive
+# typename
+# =>
+# \\relates typename
+#
+/^Primitive *$/,/^[^ ]/{
+s/^Primitive *$//
+s/^ /\\relates /
}
# Class
# Foam::className
# =>
-# @class Foam::className
+# \\class Foam::className
#
/^Class *$/,/^[^ ]/{
-/^Class/d
-s/^ /@class /
+s/^Class *$//
+s/^ /\\class /
}
# Namespace
# namespaceName
# =>
-# @namespace namespaceName
+# \namespace namespaceName
#
/^Namespace *$/,/^[^ ]/{
-/^Namespace/d
-s/^ /@namespace /
+s/^Namespace//
+s/^ /\\namespace /
}
# Typedef
# Foam::def
# =>
-# @class Foam::def
-# This is not strictly correct, but makes it easier to find the typedefs
+# \typedef Foam::def
/^Typedef *$/,/^[^ ]/{
-/^Typedef/d
-s/^ /@class /
+s/^Typedef//
+s/^ /\\typedef /
}
-# add anchor and use @brief
+# add anchor and use \brief
# the first paragraph will be 'brief' and the others 'detail'
/^Description *$/,/^[^ ]/{
/^Description/c\
-<a class="anchor" name="Description"></a>\
-@brief
+<a class="anchor" name="Description"></a> \\brief
s/^ //
}
/^Usage *$/,/^[^ ]/{
/^Usage/c\
-@par Usage
+\\par Usage
s/^ //
}
/^See *Also *$/,/^[^ ]/{
/^See *Also/c\
-@see
-s/^ //
-}
-
-/^Author *$/,/^[^ ]/{
-/^Author/c\
-@author
+\\see
s/^ //
}
/^Note *$/,/^[^ ]/{
/^Note/c\
-@note
+\\note
s/^ //
}
# remove ToDo paragraph to avoid them showing on related pages
-/^To[Dd]o *$/,/^ *$/d
+/^To[Dd]o *$/,/^[^ ]/{
+s/^To[Dd]o *$//
+s/^ .*//
+}
/^Warning *$/,/^[^ ]/{
/^Warning/c\
-@warning
+\\warning
s/^ //
}
+
/^Deprecated *$/,/^[^ ]/{
/^Deprecated/c\
-@deprecated
+\\deprecated
s/^ //
}
-/SourceFiles/,/^[ ]*$/{
-s?SourceFiles?@par Source files\
-<ul>\
- <li><a href="%filePath%">%fileName%</a></li>?
-s?^[ ]*$?</ul>\
-?
+
+/^SourceFiles *$/,/^$/{
+s?SourceFiles?\\par Source files\
+<ul><li><a href="%filePath%">%fileName%</a></li>?
+s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
+s?^$?</ul>?
+}
+
+/fileName%<\/a><\/li>$/{
+N
+s?\n$?</ul>?g
+s/<\/li>\n/<\/li> /
s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
}
diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile
index 79bc3b71cf6..3ef243ee83b 100644
--- a/doc/Doxygen/Doxyfile
+++ b/doc/Doxygen/Doxyfile
@@ -1104,7 +1104,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE =
+GENERATE_TAGFILE = DTAGS
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
@@ -1254,7 +1254,7 @@ DOTFILE_DIRS =
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
-DOT_GRAPH_MAX_NODES = 50
+DOT_GRAPH_MAX_NODES = 10
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
@@ -1264,7 +1264,7 @@ DOT_GRAPH_MAX_NODES = 50
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
-MAX_DOT_GRAPH_DEPTH = 3
+MAX_DOT_GRAPH_DEPTH = 1
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, which results in a white background.
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index a1c4e6a5fcf..0c076b4fc24 100644
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
@@ -581,7 +581,8 @@ WARN_LOGFILE =
# limit input for testing purposes
INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
$(WM_PROJECT_DIR)/src/OpenFOAM/containers \
- $(WM_PROJECT_DIR)/src/OpenFOAM/primitives
+ $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \
+ $(WM_PROJECT_DIR)/src/finiteVolume/fvMesh
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -1353,7 +1354,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE =
+GENERATE_TAGFILE = DTAGS
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
diff --git a/src/OSspecific/POSIX/fileMonitor.C b/src/OSspecific/POSIX/fileMonitor.C
index 8abbf768eac..cb0e8be4d75 100644
--- a/src/OSspecific/POSIX/fileMonitor.C
+++ b/src/OSspecific/POSIX/fileMonitor.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -109,8 +109,7 @@ namespace Foam
- //! @cond internalClass
- //- Internal tracking via stat(3p) or inotify(7)
+ //- Internal tracking via stat(3p) or inotify(7)
class fileMonitorWatcher
{
public:
@@ -140,7 +139,7 @@ namespace Foam
{
if (useInotify_)
{
-#ifdef FOAM_USE_INOTIFY
+ #ifdef FOAM_USE_INOTIFY
inotifyFd_ = inotify_init();
dirWatches_.setCapacity(sz);
dirFiles_.setCapacity(sz);
@@ -167,13 +166,13 @@ namespace Foam
<< endl;
}
}
-#else
+ #else
FatalErrorIn("fileMonitorWatcher(const bool, const label)")
<< "You selected inotify but this file was compiled"
<< " without FOAM_USE_INOTIFY"
<< "Please select another fileModification test method"
<< exit(FatalError);
-#endif
+ #endif
}
else
{
@@ -184,7 +183,7 @@ namespace Foam
//- remove all watches
inline ~fileMonitorWatcher()
{
-#ifdef FOAM_USE_INOTIFY
+ #ifdef FOAM_USE_INOTIFY
if (useInotify_ && inotifyFd_ >= 0)
{
forAll(dirWatches_, i)
@@ -200,7 +199,7 @@ namespace Foam
}
}
}
-#endif
+ #endif
}
inline bool addWatch(const label watchFd, const fileName& fName)
@@ -212,7 +211,7 @@ namespace Foam
return false;
}
-#ifdef FOAM_USE_INOTIFY
+ #ifdef FOAM_USE_INOTIFY
// Add/retrieve watch on directory containing file.
// Note that fName might be non-existing in special situations
// (master-only reading for IODictionaries)
@@ -250,7 +249,7 @@ namespace Foam
dirWatches_(watchFd) = dirWatchID;
dirFiles_(watchFd) = fName.name();
-#endif
+ #endif
}
else
{
@@ -288,7 +287,6 @@ namespace Foam
}
};
- //! @endcond
}
@@ -298,7 +296,7 @@ void Foam::fileMonitor::checkFiles() const
{
if (useInotify_)
{
-#ifdef FOAM_USE_INOTIFY
+ #ifdef FOAM_USE_INOTIFY
// Large buffer for lots of events
char buffer[EVENT_BUF_LEN];
@@ -392,7 +390,7 @@ void Foam::fileMonitor::checkFiles() const
return;
}
}
-#endif
+ #endif
}
else
{
diff --git a/src/OpenFOAM/db/runTimeSelection/globalFunctions/addToGlobalFunctionSelectionTable.H b/src/OpenFOAM/db/runTimeSelection/globalFunctions/addToGlobalFunctionSelectionTable.H
index e5c676b8be5..827723fe5c3 100644
--- a/src/OpenFOAM/db/runTimeSelection/globalFunctions/addToGlobalFunctionSelectionTable.H
+++ b/src/OpenFOAM/db/runTimeSelection/globalFunctions/addToGlobalFunctionSelectionTable.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-@file Foam::addToGlobalFunctionSelectionTable
+Global
+ Foam::addToGlobalFunctionSelectionTable
Description
Macros for easy insertion into global function selection tables
@@ -33,20 +34,18 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
// add to hash-table of functions with 'lookup' as the key
#define addNamedToGlobalFunctionSelectionTable\
(memberFunction,argNames,lookup,functionPtr) \
\
/* Add to the table, find by lookup name */ \
add##memberFunction##argNames##GlobalMemberFunctionToTable \
- add_##lookup##_##memberFunction##argNames##GlobalMemberFunctionTo##Table_\
+ add_##lookup##_##memberFunction##argNames##GlobalMemberFunctionTo##Table_ \
(#lookup, functionPtr)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
#endif
// ************************************************************************* //
diff --git a/src/OpenFOAM/db/runTimeSelection/globalFunctions/globalFunctionSelectionTables.H b/src/OpenFOAM/db/runTimeSelection/globalFunctions/globalFunctionSelectionTables.H
index 581d2cb8f5c..76481db2798 100644
--- a/src/OpenFOAM/db/runTimeSelection/globalFunctions/globalFunctionSelectionTables.H
+++ b/src/OpenFOAM/db/runTimeSelection/globalFunctions/globalFunctionSelectionTables.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-@file Foam::globalFunctionSelectionTables
+Global
+ Foam::globalFunctionSelectionTables
Description
Macros to enable the easy declaration of global function selection tables.
@@ -35,7 +36,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
// external use:
// ~~~~~~~~~~~~~
// declare a run-time selection:
@@ -138,7 +138,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
#endif
// ************************************************************************* //
diff --git a/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/addToStaticMemberFunctionSelectionTable.H b/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/addToStaticMemberFunctionSelectionTable.H
index 24550d46416..171ee131f69 100644
--- a/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/addToStaticMemberFunctionSelectionTable.H
+++ b/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/addToStaticMemberFunctionSelectionTable.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-@file Foam::addToStaticMemberFunctionSelectionTable
+Global
+ Foam::addToStaticMemberFunctionSelectionTable
Description
Macros for easy insertion into member function selection tables
@@ -47,7 +48,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
#endif
// ************************************************************************* //
diff --git a/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/staticMemberFunctionSelectionTables.H b/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/staticMemberFunctionSelectionTables.H
index b3bcee84c2e..392250477b0 100644
--- a/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/staticMemberFunctionSelectionTables.H
+++ b/src/OpenFOAM/db/runTimeSelection/staticMemberFunctions/staticMemberFunctionSelectionTables.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2010-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -21,7 +21,8 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-@file Foam::staticMemberFunctionSelectionTables
+Global
+ Foam::staticMemberFunctionSelectionTables
Description
Macros to enable the easy declaration of member function selection tables.
@@ -35,7 +36,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
// external use:
// ~~~~~~~~~~~~~
// declare a run-time selection:
@@ -140,7 +140,6 @@ Description
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-
#endif
// ************************************************************************* //
diff --git a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
index a409f01c794..405fb69ecf3 100644
--- a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
+++ b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -25,7 +25,7 @@ Class
Foam::interpolationTable
Description
- An interpolation/look-up table of scalar vs <Type> values.
+ An interpolation/look-up table of scalar vs \<Type\> values.
The reference scalar values must be monotonically increasing.
The handling of out-of-bounds values depends on the current setting
diff --git a/src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H b/src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H
index b038452515f..af8f693f0a4 100644
--- a/src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H
+++ b/src/OpenFOAM/matrices/DiagonalMatrix/DiagonalMatrix.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::DiagonalMatrix<Type>
+ Foam::DiagonalMatrix
Description
DiagonalMatrix<Type> is a 2D diagonal matrix of objects
diff --git a/src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H b/src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H
index f7a1bb902e8..ffa5f711736 100644
--- a/src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H
+++ b/src/OpenFOAM/primitives/functions/DataEntry/Constant/Constant.H
@@ -27,7 +27,7 @@ Class
Description
Templated basic entry that holds a constant value.
- Usage - for entry <entryName> having the value <value>:
+ Usage - for entry \<entryName\> having the value <value>:
@verbatim
<entryName> constant <value>
@endverbatim
diff --git a/src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H b/src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H
index 5fe73deccbf..31fedafbbe6 100644
--- a/src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H
+++ b/src/OpenFOAM/primitives/functions/DataEntry/Table/Table.H
@@ -27,7 +27,7 @@ Class
Description
Templated table container data entry. Items are stored in a list of
Tuple2's. First column is always stored as scalar entries. Data is read
- in the form, e.g. for an entry <entryName> that is (scalar, vector):
+ in the form, e.g. for an entry \<entryName\> that is (scalar, vector):
@verbatim
<entryName> table
diff --git a/src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H b/src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H
index e3360680209..33d3adcc5ee 100644
--- a/src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H
+++ b/src/OpenFOAM/primitives/functions/DataEntry/polynomial/polynomial.H
@@ -26,7 +26,7 @@ Class
Description
Polynomial container data entry for scalars. Items are stored in a list of
- Tuple2's. Data is input in the form, e.g. for an entry <entryName> that
+ Tuple2's. Data is input in the form, e.g. for an entry \<entryName\> that
describes y = x^2 + 2x^3
@verbatim
diff --git a/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H b/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
index f5a1e8b3ff1..11f68e5c173 100644
--- a/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
+++ b/src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
@@ -49,21 +49,21 @@ namespace Foam
//- An optimized version of Hasher
// @param[in] data - an array of uint32_t values
- // @param[in] len - the number of values (not bytes)
+ // @param[in] length - the number of values (not bytes)
// @param[in] seed - the previous hash, or an arbitrary value
- unsigned HasherInt(const uint32_t*, size_t length, unsigned seed = 0);
+ unsigned HasherInt(const uint32_t* data, size_t length, unsigned seed = 0);
//- An optimized version of Hasher, returning dual hash values
// @param[in] data - an array of uint32_t values
- // @param[in] len - the number of values (not bytes)
+ // @param[in] length - the number of values (not bytes)
// @param[in] hash1 - the previous hash, or an arbitrary value
// on output, the primary hash value
// @param[in] hash1 - the previous hash, or an arbitrary value
// on output, the secondary hash value
unsigned HasherDual
(
- const uint32_t*,
- size_t len,
+ const uint32_t* data,
+ size_t length,
unsigned& hash1,
unsigned& hash2
);
diff --git a/src/finiteVolume/cfdTools/general/porousMedia/PorousZones.H b/src/finiteVolume/cfdTools/general/porousMedia/PorousZones.H
index c34b60c143d..b918eda99a1 100644
--- a/src/finiteVolume/cfdTools/general/porousMedia/PorousZones.H
+++ b/src/finiteVolume/cfdTools/general/porousMedia/PorousZones.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::PorousZones<ZoneType>
+ Foam::PorousZones
Description
A centralized ZoneType collection.
diff --git a/src/finiteVolume/fvMesh/fvMesh.H b/src/finiteVolume/fvMesh/fvMesh.H
index 2a5c81fcc2d..6a98e07ed22 100644
--- a/src/finiteVolume/fvMesh/fvMesh.H
+++ b/src/finiteVolume/fvMesh/fvMesh.H
@@ -1,8 +1,8 @@
/*---------------------------------------------------------------------------*\
========= |
- \\ / F ield | OpenFOAM: The Open So
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -42,6 +42,16 @@ SourceFiles
fvMesh.C
fvMeshGeometry.C
+See Also
+ hmm
+
+Usage
+ oeuoeuoeu
+
+ToDo
+ oeuoeuoeu
+ oeueouoeu
+
\*---------------------------------------------------------------------------*/
#ifndef fvMesh_H
diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolation/surfaceInterpolate.H b/src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolation/surfaceInterpolate.H
index 7bda1c56868..207a19dcb10 100644
--- a/src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolation/surfaceInterpolate.H
+++ b/src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolation/surfaceInterpolate.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -156,14 +156,14 @@ namespace fvc
);
- //- Interpolate tmp field onto faces using 'interpolate(<name>)'
+ //- Interpolate tmp field onto faces using 'interpolate(\<name\>)'
template<class Type>
static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
(
const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
);
- //- Interpolate tmp field onto faces using 'interpolate(<name>)'
+ //- Interpolate tmp field onto faces using 'interpolate(\<name\>)'
template<class Type>
static tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate
(
diff --git a/src/lagrangian/basic/Cloud/Cloud.H b/src/lagrangian/basic/Cloud/Cloud.H
index e82907d76b8..3715bcb75ca 100644
--- a/src/lagrangian/basic/Cloud/Cloud.H
+++ b/src/lagrangian/basic/Cloud/Cloud.H
@@ -381,7 +381,7 @@ public:
IOstream::compressionType cmp
) const;
- //- Write positions to <cloudName>_positions.obj file
+ //- Write positions to \<cloudName\>_positions.obj file
void writePositions() const;
diff --git a/src/postProcessing/foamCalcFunctions/basic/addSubtract/addSubtract.H b/src/postProcessing/foamCalcFunctions/basic/addSubtract/addSubtract.H
index b7755425a60..e8c8c56c957 100644
--- a/src/postProcessing/foamCalcFunctions/basic/addSubtract/addSubtract.H
+++ b/src/postProcessing/foamCalcFunctions/basic/addSubtract/addSubtract.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -28,10 +28,10 @@ Description
adds/subtracts a field or value to/from a base field.
New field name specified by -resultName option, or automatically as:
- <baseFieldName>_add_<addSubtractFieldName>
- <baseFieldName>_add_value
- <baseFieldName>_subtract_<addSubtractFieldName>
- <baseFieldName>_subtract_value
+ \<baseFieldName\>_add_<addSubtractFieldName>
+ \<baseFieldName\>_add_value
+ \<baseFieldName\>_subtract_<addSubtractFieldName>
+ \<baseFieldName\>_subtract_value
Example usage:
addSubtract p add -value 100000 -resultName pAbs
diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H
index ffc91e74544..ce15860eab2 100644
--- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H
+++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::compressible::RASModels::mutRoughWallFunctionFvPatchScalarField
+ Foam::compressible::RASModels::mutkRoughWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity when using wall
diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H
index 2b2687c407c..85b98cc2265 100644
--- a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H
+++ b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2004-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::LESmodels::SpalartAllmaras
+ Foam::incompressible::LESModels::SpalartAllmaras
Description
SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows
diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H
index aeb936968f7..048a7a4b544 100644
--- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H
+++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::LESmodels::SpalartAllmarasDDES
+ Foam::incompressible::LESModels::SpalartAllmarasDDES
Description
SpalartAllmaras DDES LES turbulence model for incompressible flows
diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
index 80b13e1ec08..a4b8aedd5dd 100644
--- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
+++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::LESmodels::SpalartAllmarasIDDES
+ Foam::incompressible::LESModels::SpalartAllmarasIDDES
Description
SpalartAllmarasIDDES LES turbulence model for incompressible flows
diff --git a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H
index 444392668b6..5ff2022a296 100644
--- a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H
+++ b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd.
+ \\ / A nd | Copyright (C) 2008-2011 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::LESmodels::kOmegaSSTSAS
+ Foam::incompressible::LESModels::kOmegaSSTSAS
Description
kOmegaSSTSAS LES turbulence model for incompressible flows
--
GitLab