diff --git a/src/OpenFOAM/db/dictionary/dictionary.H b/src/OpenFOAM/db/dictionary/dictionary.H
index 02325b4638a58222a6f48680898a4e69be64ba93..c60eb8e463aebc61e5d5a9b1e6ea3e48441723a2 100644
--- a/src/OpenFOAM/db/dictionary/dictionary.H
+++ b/src/OpenFOAM/db/dictionary/dictionary.H
@@ -1464,10 +1464,10 @@ public:
}
#ifdef COMPAT_OPENFOAM_ORG
- //! \cond compat_openfoam_org
- // Accommodate name changes from 2019-11
+ //! Handle new openfoam-org method type (2019-11)
+ // Only available if compiled with COMPAT_OPENFOAM_ORG
template<class T>
- FOAM_DEPRECATED_FOR(2019-11, "get(). openfoam.org compatibility")
+ FOAM_DEPRECATED_FOR(2019-11, "get() method - openfoam.org compat")
T lookup
(
const word& keyword,
@@ -1484,7 +1484,7 @@ public:
#undef defineDictionaryGetter
#define defineDictionaryGetter(Func, Type) \
- /** \brief Same as get\<Type\>(const word&, keyType::option) */ \
+ /*! \brief Same as get\<Type\>(const word&, keyType::option) */ \
Type Func \
( \
const word& keyword, \
diff --git a/src/OpenFOAM/expressions/exprEntry/expressionEntryDimensioned.H b/src/OpenFOAM/expressions/exprEntry/expressionEntryDimensioned.H
index 11adf6b73fcf3cd0521b50ebba2379443d876739..3fe380abec8a9ca37dcb82ec4b3b979f0429bf0a 100644
--- a/src/OpenFOAM/expressions/exprEntry/expressionEntryDimensioned.H
+++ b/src/OpenFOAM/expressions/exprEntry/expressionEntryDimensioned.H
@@ -49,10 +49,10 @@ namespace exprTools
/*! \brief Create an expression string from a DimType as its value */ \
struct DimType##Entry : public exprTools::expressionEntry \
{ \
- /*! To string */ \
+ /*! \brief Entry to string */ \
static string evaluate(const entry& e); \
\
- /*! To string */ \
+ /*! \brief Entry to string */ \
virtual string toExpr(const entry& e) const \
{ \
return evaluate(e); \
diff --git a/src/OpenFOAM/expressions/exprEntry/expressionEntryVectors.H b/src/OpenFOAM/expressions/exprEntry/expressionEntryVectors.H
index 781f679db3660f80a5b1c95173aa4766964dd95b..33a3b345d50fee7ed1abc5acf411b4744d2d1b69 100644
--- a/src/OpenFOAM/expressions/exprEntry/expressionEntryVectors.H
+++ b/src/OpenFOAM/expressions/exprEntry/expressionEntryVectors.H
@@ -49,10 +49,10 @@ namespace exprTools
/*! \brief Create an expression string from a Type */ \
struct Type##Entry : public exprTools::expressionEntry \
{ \
- /*! To string */ \
+ /*! \brief Entry to string */ \
static string evaluate(const entry& e); \
\
- /*! To string */ \
+ /*! \brief Entry to string */ \
virtual string toExpr(const entry& e) const \
{ \
return evaluate(e); \
diff --git a/src/OpenFOAM/expressions/exprResult/exprResult.H b/src/OpenFOAM/expressions/exprResult/exprResult.H
index 4588b22997b9b3b32ccd863ddd9b34a2398f87f5..495573c39486977abc1f807c4c81d06d1ba6acf3 100644
--- a/src/OpenFOAM/expressions/exprResult/exprResult.H
+++ b/src/OpenFOAM/expressions/exprResult/exprResult.H
@@ -341,7 +341,7 @@ public:
#undef exprResult_Construct
#define exprResult_Construct(Type) \
- /*! Construct from single value of Type */ \
+ /*! \brief Construct from single value of Type */ \
explicit exprResult(const Type& val) : exprResult() \
{ \
setSingleValue(val); \
diff --git a/src/OpenFOAM/fields/Fields/Field/FieldFunctions.H b/src/OpenFOAM/fields/Fields/Field/FieldFunctions.H
index b8fed57ff8484d206539a8a5c22bf586773fc984..e57e56b93e9016ce9f44612a94424fe3055f13b4 100644
--- a/src/OpenFOAM/fields/Fields/Field/FieldFunctions.H
+++ b/src/OpenFOAM/fields/Fields/Field/FieldFunctions.H
@@ -180,7 +180,7 @@ tmp<Field<Type>> cmptMagSqr(const tmp<Field<Type>>& tf);
#define TMP_UNARY_FUNCTION(ReturnType, Func) \
\
-/** \brief Apply the \c Func() function on the tmp field */ \
+/*! \brief Apply the \c Func() function on the tmp field */ \
template<class Type> \
ReturnType Func(const tmp<Field<Type>>& tf1);
diff --git a/src/OpenFOAM/primitives/Scalar/doubleFloat.H b/src/OpenFOAM/primitives/Scalar/doubleFloat.H
index 4442a4eb1b48bc772bc2bb5f6ed2ba5930d5dd5a..131eb07c1c66b949eaf4576474e5504cdc8cc7e6 100644
--- a/src/OpenFOAM/primitives/Scalar/doubleFloat.H
+++ b/src/OpenFOAM/primitives/Scalar/doubleFloat.H
@@ -53,7 +53,7 @@ inline bool equal(const T& s1, const T& s2)
\
MAXMIN(retType, type1, type2) \
\
-/** \brief Raise base to the power expon */ \
+/*! \brief Raise base to the power expon */ \
inline double pow(const type1 base, const type2 expon) \
{ \
return ::pow(double(base), double(expon)); \
diff --git a/src/OpenFOAM/primitives/ints/int/int.H b/src/OpenFOAM/primitives/ints/int/int.H
index 931941f71fb142404c6aa071ec136a514f038fde..3157d10a314e2c728dce2459a9a2cada3b612b7d 100644
--- a/src/OpenFOAM/primitives/ints/int/int.H
+++ b/src/OpenFOAM/primitives/ints/int/int.H
@@ -48,13 +48,13 @@ namespace Foam
#define MAXMIN(retType, type1, type2) \
\
-/** \brief Floating/integral min. Use stdFoam::min() to preserve references */ \
+/*! \brief Floating/integral min. Use stdFoam::min() to preserve references */ \
inline retType min(const type1 s1, const type2 s2) \
{ \
return (s1 < s2) ? s1 : s2; \
} \
\
-/** \brief Floating/integral max. Use stdFoam::max() to preserve references */ \
+/*! \brief Floating integral max. Use stdFoam::max() to preserve references */ \
inline retType max(const type1 s1, const type2 s2) \
{ \
return (s2 < s1) ? s1 : s2; \
diff --git a/src/OpenFOAM/primitives/ints/uint/uint.H b/src/OpenFOAM/primitives/ints/uint/uint.H
index df5fe5d302ae943449435ec6859b791d6bf263da..bd028df8b6c943b470b76b28529490155e36a5c9 100644
--- a/src/OpenFOAM/primitives/ints/uint/uint.H
+++ b/src/OpenFOAM/primitives/ints/uint/uint.H
@@ -50,13 +50,13 @@ namespace Foam
#define MAXMIN(retType, type1, type2) \
\
-/** \brief Floating/integral min. Use stdFoam::min() to preserve references */ \
+/*! \brief Floating/integral min. Use stdFoam::min() to preserve references */ \
inline retType min(const type1 s1, const type2 s2) \
{ \
return (s1 < s2) ? s1 : s2; \
} \
\
-/** \brief Floating/integral max. Use stdFoam::max() to preserve references */ \
+/*! \brief Floating/integral max. Use stdFoam::max() to preserve references */ \
inline retType max(const type1 s1, const type2 s2) \
{ \
return (s2 < s1) ? s1 : s2; \
diff --git a/src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.H b/src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.H
index eaa1ebe02be5d766d8fbb930ac91a674c9e4b59c..f36ffcee9eca58bb7b277fe91f0526ddcd87b373 100644
--- a/src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.H
+++ b/src/dynamicMesh/fvMeshSubsetProxy/fvMeshSubsetProxy.H
@@ -62,10 +62,10 @@ public:
//- Internal bookkeeping for subset type
enum subsetType
{
- NONE, //<! No subset
- SET, //<! Subset with a cellSet
- ZONE, //<! Subset with a cellZone
- ZONES //<! Subset with multiple cellZones
+ NONE, //!< No subset
+ SET, //!< Subset with a cellSet
+ ZONE, //!< Subset with a cellZone
+ ZONES //!< Subset with multiple cellZones
};
diff --git a/src/fileFormats/nastran/NASCore.H b/src/fileFormats/nastran/NASCore.H
index d059a754b5d8f5f4823becc9fac4c9824b238bff..352d40d77280909759663e3d9aa48d1e9d1e1f79 100644
--- a/src/fileFormats/nastran/NASCore.H
+++ b/src/fileFormats/nastran/NASCore.H
@@ -63,9 +63,9 @@ public:
//- File field formats
enum fieldFormat
{
- SHORT, //<! Short format (field width = 8)
- LONG, //<! Long format (field width = 16)
- FREE //<! Free format (comma-separated fields)
+ SHORT, //!< Short format (field width = 8)
+ LONG, //!< Long format (field width = 16)
+ FREE //!< Free format (comma-separated fields)
};
//- Selection names for the NASTRAN file field formats
diff --git a/src/fileFormats/vtk/base/foamVtkCore.H b/src/fileFormats/vtk/base/foamVtkCore.H
index 3025d6593df4997644720c3c781f66613ed87171..a51ff4dd73f0eac6c26f894ccb2d99793e9cf5de 100644
--- a/src/fileFormats/vtk/base/foamVtkCore.H
+++ b/src/fileFormats/vtk/base/foamVtkCore.H
@@ -54,9 +54,9 @@ namespace vtk
//- The context when outputting a VTK file (XML or legacy).
enum OutputContext
{
- INLINE, //<! Generate header and inline data
- HEADER, //<! Generate header only
- APPEND //<! Generate append-data
+ INLINE, //!< Generate header and inline data
+ HEADER, //!< Generate header only
+ APPEND //!< Generate append-data
};
diff --git a/src/fileFormats/vtk/part/foamVtuSizing.H b/src/fileFormats/vtk/part/foamVtuSizing.H
index d8c97aa4b2834ce86cb4fd4a41c04d6d1064ed0b..860674fbdec16c38f7aa1f5dd3b341231507bcd2 100644
--- a/src/fileFormats/vtk/part/foamVtuSizing.H
+++ b/src/fileFormats/vtk/part/foamVtuSizing.H
@@ -339,7 +339,7 @@ public:
#undef declarePopulateInternalMethod
#define declarePopulateInternalMethod(Type) \
\
- /*! Populate lists for Internal VTK format */ \
+ /*! \brief Populate lists for Internal VTK format */ \
void populateInternal \
( \
const polyMesh& mesh, \
@@ -352,7 +352,7 @@ public:
const enum contentType output \
) const; \
\
- /*! Populate lists for Internal VTK format */ \
+ /*! \brief Populate lists for Internal VTK format */ \
void populateInternal \
( \
const polyMesh& mesh, \
diff --git a/src/meshTools/coordinate/systems/coordinateSystem.H b/src/meshTools/coordinate/systems/coordinateSystem.H
index 42e5bc2d119dca1207ac45d173188c8b12ac92ad..9048c7c3c3c1ebb02c7d2033ae00a02a62f6cdc8 100644
--- a/src/meshTools/coordinate/systems/coordinateSystem.H
+++ b/src/meshTools/coordinate/systems/coordinateSystem.H
@@ -638,37 +638,37 @@ public:
#undef defineCoordinateSystemTransform
#define defineCoordinateSystemTransform(Op, RetType, Type) \
\
- /**! With constant rotation tensor */ \
+ /*! \brief With constant rotation tensor */ \
virtual RetType Op(const Type& input) const; \
\
- /**! With constant rotation tensor */ \
+ /*! \brief With constant rotation tensor */ \
virtual tmp<Field<RetType>> Op(const UList<Type>& input) const; \
\
- /**! With rotation tensor at given global position */ \
+ /*! \brief With rotation tensor at given global position */ \
virtual RetType Op(const point& global, const Type& input) const; \
\
- /**! With rotation tensors at given global positions */ \
+ /*! \brief With rotation tensors at given global positions */ \
virtual tmp<Field<RetType>> Op \
( \
const UList<point>& global, \
const Type& input \
) const; \
\
- /**! With rotation tensors at given global positions */ \
+ /*! \brief With rotation tensors at given global positions */ \
virtual tmp<Field<RetType>> Op \
( \
const pointUIndList& global, \
const Type& input \
) const; \
\
- /**! With rotation tensors at given global positions */ \
+ /*! \brief With rotation tensors at given global positions */ \
virtual tmp<Field<RetType>> Op \
( \
const UList<point>& global, \
const UList<Type>& input \
) const; \
\
- /**! With rotation tensors at given global positions */ \
+ /*! \brief With rotation tensors at given global positions */ \
virtual tmp<Field<RetType>> Op \
( \
const pointUIndList& global, \
diff --git a/src/meshTools/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.H b/src/meshTools/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.H
index 559a6db39889c1f39bec177612466969212fb88f..2a4aa91f735da56e486baa107b66eb875b020ba2 100644
--- a/src/meshTools/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.H
+++ b/src/meshTools/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.H
@@ -121,8 +121,8 @@ public:
//- Enumeration defining the valid options
enum faceAction
{
- ALL, //<!- Select all faces that meet the criteria
- CLOSEST //<!- Select faces belong to the closest contiguous plane
+ ALL, //!< Select all faces that meet the criteria
+ CLOSEST //!< Select faces belong to the closest contiguous plane
};
diff --git a/src/surfMesh/writers/surfaceWriter.H b/src/surfMesh/writers/surfaceWriter.H
index 2b18143c18a99503a4d58bde0ae3fc411d5e03a4..8d797a330f60a35e27ab20a339fc6bb96f77a5cd 100644
--- a/src/surfMesh/writers/surfaceWriter.H
+++ b/src/surfMesh/writers/surfaceWriter.H
@@ -499,7 +499,7 @@ public:
#undef declareSurfaceWriterWriteMethod
#define declareSurfaceWriterWriteMethod(Type) \
- /**! Write field of Type (per face or vertex) */ \
+ /*! \brief Write field of Type (per face or vertex) */ \
virtual fileName write \
( \
const word& fieldName, /*!< Name of field */ \
@@ -517,7 +517,7 @@ public:
#undef declareSurfaceWriterWriteMethod
#define declareSurfaceWriterWriteMethod(Type) \
\
- /**! Write field of Type (per face or vertex) */ \
+ /*! \brief Write field of Type (per face or vertex) */ \
virtual fileName write \
( \
const word& fieldName, /*!< Name of field */ \