Commit 4b964f67 authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: fix doxygen comments

parent 6e3bc1f7
......@@ -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, \
......
......@@ -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); \
......
......@@ -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); \
......
......@@ -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); \
......
......@@ -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);
......
......@@ -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)); \
......
......@@ -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; \
......
......@@ -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; \
......
......@@ -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
};
......
......@@ -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
......
......@@ -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
};
......
......@@ -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, \
......
......@@ -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, \
......
......@@ -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
};
......
......@@ -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 */ \
......
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