From ab38c040064b8070fd3b0475b9dd5de3061a1fce Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 9 Jan 2018 16:06:40 +0100 Subject: [PATCH] STYLE: note deprecated status for NamedEnum --- doc/Doxygen/footer.html | 2 +- src/OpenFOAM/primitives/enums/NamedEnum.H | 15 +++++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/doc/Doxygen/footer.html b/doc/Doxygen/footer.html index 649b906855..03102814c7 100644 --- a/doc/Doxygen/footer.html +++ b/doc/Doxygen/footer.html @@ -15,7 +15,7 @@

- Copyright © 2011-2016  + Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered diff --git a/src/OpenFOAM/primitives/enums/NamedEnum.H b/src/OpenFOAM/primitives/enums/NamedEnum.H index db41012cad..ff7a0050ac 100644 --- a/src/OpenFOAM/primitives/enums/NamedEnum.H +++ b/src/OpenFOAM/primitives/enums/NamedEnum.H @@ -28,6 +28,13 @@ Description A NamedEnum is a wrapper around a list of names that represent particular enumeration values. + \deprecated This class is retained for compatibility only and should + not normally be used for any new code. + The Foam::Enum class is robuster, more flexible, easier to use. + +See Also + Foam::Enum + SourceFiles NamedEnum.C @@ -97,7 +104,7 @@ public: // Member Functions - // Access + // Access //- The number of lookup names for the enumeration inline label size() const; @@ -115,7 +122,7 @@ public: List values() const; - // Query + // Query //- Test if there is an enumeration corresponding to the given name. inline bool found(const word& enumName) const; @@ -127,7 +134,7 @@ public: bool hasName(const EnumType e) const; - // Lookup + // Lookup //- Lookup the key in the dictionary and return the corresponding // enumeration element based on its name. @@ -150,7 +157,7 @@ public: ) const; - // IO + // IO //- Read a word from Istream and return the corresponding enumeration EnumType read(Istream& is) const;