Skip to content

Commit b6a4452

Browse files
committed
update doc
fix noexcept nameof_enum_or
1 parent 59411bf commit b6a4452

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

doc/reference.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [`NAMEOF_FULL` obtains full name of variable, function, macro.](#nameof_full)
55
* [`NAMEOF_RAW` obtains raw name of variable, function, macro.](#nameof_raw)
66
* [`NAMEOF_ENUM` obtains name of enum variable.](#nameof_enum)
7+
* [`NAMEOF_ENUM_OR` Obtains name of enum variable or default value if enum variable out of range.](#nameof_enum_or)
78
* [`NAMEOF_ENUM_CONST` obtains name of static storage enum variable.](#nameof_enum_const)
89
* [`NAMEOF_ENUM_FLAG` obtains name of enum-flags variable.](#nameof_enum_flag)
910
* [`NAMEOF_TYPE` obtains type name.](#nameof_type)
@@ -43,7 +44,7 @@
4344
4445
## `NAMEOF`
4546
46-
* Obtains simple (unqualified) name of variable, function, macro.
47+
* Obtains name of variable, function, macro.
4748
4849
* Returns `nameof::cstring` - constexpr implementation of an string. Marked `constexpr` and `noexcept`.
4950
@@ -72,7 +73,7 @@
7273
7374
## `NAMEOF_FULL`
7475
75-
* Obtains simple (unqualified) full (with template suffix) name of variable, function, macro.
76+
* Obtains full (with template suffix) name of variable, function, macro.
7677
7778
* Returns `nameof::cstring` - constexpr implementation of an string. Marked `constexpr` and `noexcept`.
7879
@@ -106,7 +107,7 @@
106107
107108
## `NAMEOF_ENUM`
108109
109-
* Obtains simple (unqualified) name of enum variable.
110+
* Obtains name of enum variable.
110111
111112
* Returns `string_view`. Marked `constexpr` and `noexcept`.
112113
@@ -120,9 +121,17 @@
120121
nameof::nameof_enum(color) -> "RED"
121122
```
122123

124+
# `NAMEOF_ENUM_OR`
125+
126+
* Obtains name of enum variable or default value if enum variable out of range.
127+
128+
* Returns `string`.
129+
130+
* If argument does not have name or [out of range](limitations.md#nameof-enum), returns `default_value`.
131+
123132
## `NAMEOF_ENUM_CONST`
124133

125-
* Obtains simple (unqualified) name of static storage enum variable.
134+
* Obtains name of static storage enum variable.
126135

127136
* Returns `string_view`. Marked `constexpr` and `noexcept`.
128137

@@ -139,7 +148,7 @@
139148
140149
## `NAMEOF_ENUM_FLAG`
141150
142-
* Obtains simple (unqualified) name of enum flag variable.
151+
* Obtains name of enum flag variable.
143152
144153
* Returns `string`.
145154

include/nameof.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,7 @@ template <typename E>
10031003

10041004
// Obtains name of enum variable or default value if enum variable out of range.
10051005
template <typename E>
1006-
[[nodiscard]] auto nameof_enum_or(E value, string_view default_value) noexcept -> detail::enable_if_enum_t<E, string> {
1006+
[[nodiscard]] auto nameof_enum_or(E value, string_view default_value) -> detail::enable_if_enum_t<E, string> {
10071007
using D = std::decay_t<E>;
10081008

10091009
if (auto v = nameof_enum<D>(value); !v.empty()) {

0 commit comments

Comments
 (0)