From 56e07de724a455ee4058eb7ad89bb505325a3d6f Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Mon, 14 Feb 2011 10:00:48 +0100
Subject: [PATCH] STYLE: changed some missed doxygen '@' to '\'
---
.../mesh/conversion/foamToStarMesh/foamToStarMesh.C | 2 +-
.../preProcessing/changeDictionary/changeDictionary.C | 2 +-
bin/foamEtcFile | 6 +++---
src/OSspecific/POSIX/regExp.H | 2 +-
.../includeIfPresentEntry/includeIfPresentEntry.H | 2 +-
src/OpenFOAM/global/foamDoc.H | 10 +++++-----
src/conversion/meshWriter/meshWriter.H | 2 +-
.../coordinateRotation/coordinateRotation.H | 2 +-
.../surfaceFormats/stl/STLsurfaceFormatASCII.L | 10 +++++-----
.../chemistryReaders/chemkinReader/chemkinLexer.L | 10 +++++-----
.../triSurface/interfaces/STL/readSTLASCII.L | 8 ++++----
11 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index b154a3816d7..af4985dd433 100644
--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
@@ -40,7 +40,7 @@ Usage
Note
The cellTable information available in the files
- \c constant/cellTable and @c constant/polyMesh/cellTableId
+ \c constant/cellTable and \c constant/polyMesh/cellTableId
will be used if available. Otherwise the cellZones are used when
creating the cellTable information.
diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
index b580a27e713..083107efb94 100644
--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@@ -29,7 +29,7 @@ Description
type in the field and polyMesh/boundary files.
Reads dictionaries (fields) and entries to change from a dictionary.
- E.g. to make the \em movingWall a \em fixedValue for @em p but all other
+ E.g. to make the \em movingWall a \em fixedValue for \em p but all other
\em Walls a zeroGradient boundary condition, the
\c system/changeDictionaryDict would contain the following:
\verbatim
diff --git a/bin/foamEtcFile b/bin/foamEtcFile
index 5bae566b55a..20b5be0fedf 100755
--- a/bin/foamEtcFile
+++ b/bin/foamEtcFile
@@ -3,7 +3,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
@@ -33,10 +33,10 @@
# personal settings to site-wide settings.
#
# For example, within the user ~/.OpenFOAM/<VER>/prefs.sh:
-# @verbatim
+# \code
# foamPrefs=`$WM_PROJECT_DIR/bin/foamEtcFile -m go prefs.sh` \
# && _foamSource $foamPrefs
-# @endverbatim
+# \endcode
#
#-------------------------------------------------------------------------------
usage() {
diff --git a/src/OSspecific/POSIX/regExp.H b/src/OSspecific/POSIX/regExp.H
index 7144d5723ff..9106264ac81 100644
--- a/src/OSspecific/POSIX/regExp.H
+++ b/src/OSspecific/POSIX/regExp.H
@@ -29,7 +29,7 @@ Description
SeeAlso
The manpage regex(7) for more information about POSIX regular expressions.
- These differ somewhat from \c Perl and @c sed regular expressions.
+ These differ somewhat from \c Perl and \c sed regular expressions.
SourceFiles
regExp.C
diff --git a/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H
index 98df647af71..f723f5ee98f 100644
--- a/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H
+++ b/src/OpenFOAM/db/dictionary/functionEntries/includeIfPresentEntry/includeIfPresentEntry.H
@@ -27,7 +27,7 @@ Class
Description
Specify a file to include if it exists. Expects a single string to follow.
- The \c \#includeIfPresent directive is similar to the @c \#include
+ The \c \#includeIfPresent directive is similar to the \c \#include
directive, but does not generate an error if the file does not exist.
See Also
diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H
index c44819062d1..04af83ae1b4 100644
--- a/src/OpenFOAM/global/foamDoc.H
+++ b/src/OpenFOAM/global/foamDoc.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,9 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
-@mainpage OpenFOAM®: open source CFD
+\mainpage OpenFOAM®: open source CFD
-@section about About OpenFOAM
+\section about About OpenFOAM
OpenFOAM is a free, open source CFD software package produced by
a commercial company,
@@ -35,7 +35,7 @@ License
heat transfer, to solid dynamics and electromagnetics.
<a href="http://www.openfoam.com/features">More ...</a>
-@section users Our commitment to the users
+\section users Our commitment to the users
OpenFOAM comes with full commercial support from OpenCFD, including
<a href="http://www.openfoam.com/support/software.php">
@@ -48,7 +48,7 @@ License
These activities fund the development, maintenance and release of
OpenFOAM to make it an extremely viable commercial open source product.
-@section opensource Our commitment to open source
+\section opensource Our commitment to open source
OpenCFD is committed to open source software, continually developing and
maintaining OpenFOAM under the
diff --git a/src/conversion/meshWriter/meshWriter.H b/src/conversion/meshWriter/meshWriter.H
index 4aace111bc0..431b565be27 100644
--- a/src/conversion/meshWriter/meshWriter.H
+++ b/src/conversion/meshWriter/meshWriter.H
@@ -35,7 +35,7 @@ Description
write OpenFOAM meshes and/or results to another CFD format
- currently just STAR-CD
-@par Files
+\par Files
"constant/boundaryRegion" is an IOMap<dictionary> that contains
the boundary type and names. eg,
diff --git a/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H b/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
index f7a44de396e..8ae67e952cd 100644
--- a/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
+++ b/src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.H
@@ -32,7 +32,7 @@ Description
or (e3/e1). Any nonorthogonality will be absorbed into the second vector.
For convenience, the dictionary constructor forms allow a few shortcuts:
- - if the \c type is not otherwise specified, the type @c axes
+ - if the \c type is not otherwise specified, the type \c axes
is implicit
- if an axes specification (eg, e3/e1) is used, the coordinateRotation
sub-dictionary can be dropped.
diff --git a/src/surfMesh/surfaceFormats/stl/STLsurfaceFormatASCII.L b/src/surfMesh/surfaceFormats/stl/STLsurfaceFormatASCII.L
index 5ba13632973..6145df61ca8 100644
--- a/src/surfMesh/surfaceFormats/stl/STLsurfaceFormatASCII.L
+++ b/src/surfMesh/surfaceFormats/stl/STLsurfaceFormatASCII.L
@@ -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
@@ -36,7 +36,7 @@ License
using namespace Foam;
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
-//! @cond dummy
+//! \cond dummy
int yyFlexLexer::yylex()
{
FatalErrorIn("yyFlexLexer::yylex()")
@@ -44,12 +44,12 @@ int yyFlexLexer::yylex()
<< abort(FatalError);
return 0;
}
-//! @endcond
+//! \endcond
// Dummy yywrap to keep yylex happy at compile time.
// It is called by yylex but is not used as the mechanism to change file.
// See <<EOF>>
-//! @cond dummy
+//! \cond dummy
#if YY_FLEX_SUBMINOR_VERSION < 34
extern "C" int yywrap()
#else
@@ -58,7 +58,7 @@ int yyFlexLexer::yywrap()
{
return 1;
}
-//! @endcond
+//! \endcond
//- A lexer for parsing STL ASCII files.
diff --git a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinLexer.L b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinLexer.L
index 58987ae82e9..9cdded54d93 100644
--- a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinLexer.L
+++ b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinLexer.L
@@ -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
@@ -38,7 +38,7 @@ License
int Foam::chemkinReader::yyBufSize = YY_BUF_SIZE;
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
-//! @cond dummy
+//! \cond dummy
int yyFlexLexer::yylex()
{
FatalErrorIn("yyFlexLexer::yylex()")
@@ -47,13 +47,13 @@ int yyFlexLexer::yylex()
return 0;
}
-//! @endcond
+//! \endcond
// Dummy yywrap to keep yylex happy at compile time.
// It is called by yylex but is not used as the mechanism to change file.
// See <<EOF>>
-//! @cond dummy
+//! \cond dummy
#if YY_FLEX_SUBMINOR_VERSION < 34
extern "C" int yywrap()
#else
@@ -62,7 +62,7 @@ int yyFlexLexer::yywrap()
{
return 1;
}
-//! @endcond
+//! \endcond
Foam::string foamSpecieString(const char* YYText)
diff --git a/src/triSurface/triSurface/interfaces/STL/readSTLASCII.L b/src/triSurface/triSurface/interfaces/STL/readSTLASCII.L
index 9cb9f1d3d19..20c63997c7b 100644
--- a/src/triSurface/triSurface/interfaces/STL/readSTLASCII.L
+++ b/src/triSurface/triSurface/interfaces/STL/readSTLASCII.L
@@ -39,7 +39,7 @@ License
using namespace Foam;
// Dummy yyFlexLexer::yylex() to keep the linker happy. It is not called
-//! @cond dummy
+//! \cond dummy
int yyFlexLexer::yylex()
{
FatalErrorIn("yyFlexLexer::yylex()")
@@ -47,12 +47,12 @@ int yyFlexLexer::yylex()
<< abort(FatalError);
return 0;
}
-//! @endcond
+//! \endcond
// Dummy yywrap to keep yylex happy at compile time.
// It is called by yylex but is not used as the mechanism to change file.
// See <<EOF>>
-//! @cond dummy
+//! \cond dummy
#if YY_FLEX_SUBMINOR_VERSION < 34
extern "C" int yywrap()
#else
@@ -61,7 +61,7 @@ int yyFlexLexer::yywrap()
{
return 1;
}
-//! @endcond
+//! \endcond
class STLLexer
--
GitLab