STYLE: FOAM_DEPRECATED_FOR instead of FOAM_DEPRECATED

- explains what the preferred replacement should be
This commit is contained in:
Mark Olesen
2023-07-28 19:37:51 +02:00
parent a3ec19c344
commit 36161e682a
4 changed files with 12 additions and 12 deletions

View File

@ -378,7 +378,7 @@ public:
// \deprecated(2018-11) - should generally use construct from // \deprecated(2018-11) - should generally use construct from
// dictionary or primitiveEntry instead // dictionary or primitiveEntry instead
// (additional checks on the input stream). // (additional checks on the input stream).
FOAM_DEPRECATED(2018-11) FOAM_DEPRECATED_FOR(2018-11, "construct from dictionary or entry")
explicit dimensioned(Istream& is); explicit dimensioned(Istream& is);
//- Deprecated(2018-11) Construct from Istream with given name //- Deprecated(2018-11) Construct from Istream with given name
@ -386,7 +386,7 @@ public:
// \deprecated(2018-11) - should generally use construct from // \deprecated(2018-11) - should generally use construct from
// dictionary or primitiveEntry instead // dictionary or primitiveEntry instead
// (additional checks on the input stream). // (additional checks on the input stream).
FOAM_DEPRECATED(2018-11) FOAM_DEPRECATED_FOR(2018-11, "construct from dictionary or entry")
dimensioned(const word& name, Istream& is); dimensioned(const word& name, Istream& is);
//- Deprecated(2018-11) Construct from Istream with given name //- Deprecated(2018-11) Construct from Istream with given name
@ -397,7 +397,7 @@ public:
// \deprecated(2018-11) - should generally use construct from // \deprecated(2018-11) - should generally use construct from
// dictionary or primitiveEntry instead // dictionary or primitiveEntry instead
// (additional checks on the input stream). // (additional checks on the input stream).
FOAM_DEPRECATED(2018-11) FOAM_DEPRECATED_FOR(2018-11, "construct from dictionary or entry")
dimensioned(const word& name, const dimensionSet& dims, Istream& is); dimensioned(const word& name, const dimensionSet& dims, Istream& is);

View File

@ -196,7 +196,7 @@ public:
//- Deprecated(2020-01) Construct from components //- Deprecated(2020-01) Construct from components
// \deprecated(2020-01) - order inconsistent with other identifiers // \deprecated(2020-01) - order inconsistent with other identifiers
FOAM_DEPRECATED(2020-01) FOAM_DEPRECATED_FOR(2020-01, "construct name/index/type")
geometricSurfacePatch geometricSurfacePatch
( (
const word& geometricType, const word& geometricType,

View File

@ -35,8 +35,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef decompositionModel_H #ifndef Foam_decompositionModel_H
#define decompositionModel_H #define Foam_decompositionModel_H
#include "IOdictionary.H" #include "IOdictionary.H"
#include "MeshObject.H" #include "MeshObject.H"
@ -126,7 +126,7 @@ public:
//- Deprecated(2021-04) compatibility constructor //- Deprecated(2021-04) compatibility constructor
// \deprecated(2021-04) // \deprecated(2021-04)
FOAM_DEPRECATED(2021-04) FOAM_DEPRECATED_FOR(2021-04, "construct mesh/fileName/dictionary")
decompositionModel decompositionModel
( (
const polyMesh& mesh, const polyMesh& mesh,
@ -139,7 +139,7 @@ public:
//- Deprecated(2021-04) compatibility selector //- Deprecated(2021-04) compatibility selector
// \deprecated(2021-04) // \deprecated(2021-04)
FOAM_DEPRECATED(2021-04) FOAM_DEPRECATED_FOR(2021-04, "New mesh/fileName/dictionary")
static const decompositionModel& New static const decompositionModel& New
( (
const polyMesh& mesh, const polyMesh& mesh,

View File

@ -35,8 +35,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef surfacePatch_H #ifndef Foam_surfacePatch_H
#define surfacePatch_H #define Foam_surfacePatch_H
#include "geometricSurfacePatch.H" #include "geometricSurfacePatch.H"
@ -81,7 +81,7 @@ public:
//- Default construct, with zero start, size, index=-1 //- Default construct, with zero start, size, index=-1
surfacePatch(); surfacePatch();
//- Construct null with specified index //- Default construct, with zero start, size, and specified index
explicit surfacePatch(const label index); explicit surfacePatch(const label index);
//- Construct from components //- Construct from components
@ -148,7 +148,7 @@ public:
//- Deprecated(2020-01) Construct from components //- Deprecated(2020-01) Construct from components
// \deprecated(2020-01) - order inconsistent with other identifiers // \deprecated(2020-01) - order inconsistent with other identifiers
FOAM_DEPRECATED(2020-01) FOAM_DEPRECATED_FOR(2020-01, "construct name/size/start/index/type")
surfacePatch surfacePatch
( (
const word& geometricType, const word& geometricType,