mirror/magic_enum
1
0
Fork 0
mirror of https://github.com/Neargye/magic_enum.git synced 2026-01-10 23:44:29 +00:00
Code Activity

update doc

Browse source 
fix #68
This commit is contained in:
neargye 2020-12-23 14:14:28 +02:00
parent 9ed98e3463
commit dee5abdfbd
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
doc/limitations.md
View file

@ -48,10 +48,10 @@
ConvexEnd = 2, ConvexEnd = 2,
Donut = 2, // Won't work too. Donut = 2, // Won't work too.
Banana = 3, Banana = 3,
COUNT = 4, COUNT = 4
}; };
// magic_enum::enum_cast<ShapeKind>("Box") -> std::nullopt or ShapeKind::Box // magic_enum::enum_cast<ShapeKind>("Box") -> std::nullopt
// magic_enum::enum_name(ShapeKind::Box) -> "ConvexBegin" or "" // magic_enum::enum_name(ShapeKind::Box) -> "ConvexBegin"
``` ```
One of the possible workaround the issue: One of the possible workaround the issue:
@ -70,7 +70,7 @@
// Non-reflected aliases. // Non-reflected aliases.
ConvexBegin = Box, ConvexBegin = Box,
ConvexEnd = Sphere + 1, ConvexEnd = Sphere + 1
}; };
// magic_enum::enum_cast<ShapeKind>("Box") -> ShapeKind::Box // magic_enum::enum_cast<ShapeKind>("Box") -> ShapeKind::Box
// magic_enum::enum_name(ShapeKind::Box) -> "Box" // magic_enum::enum_name(ShapeKind::Box) -> "Box"
@ -80,9 +80,18 @@
// magic_enum::enum_name(ShapeKind::ConvexBegin) -> "Box" // magic_enum::enum_name(ShapeKind::ConvexBegin) -> "Box"
``` ```
On some compiler enum-aliases not supported, [for example Visual Studio 2017](https://github.com/Neargye/magic_enum/issues/36). On some compiler enum-aliases not supported, [for example Visual Studio 2017](https://github.com/Neargye/magic_enum/issues/36), macro `MAGIC_ENUM_SUPPORTED_ALIASES` will be undefined.
It is possible to check whether enum-aliases supported using a macro `MAGIC_ENUM_SUPPORTED_ALIASES`. ```cpp
enum Number {
one = 1,
ONE = 1
};
// magic_enum::enum_cast<Number>("one") -> std::nullopt
// magic_enum::enum_name(Number::one) -> ""
// magic_enum::enum_cast<Number>("ONE") -> std::nullopt
// magic_enum::enum_name(Number::ONE) -> ""
```
* If you hit a message like this: * If you hit a message like this: