Skip to content

Commit 58ecac6

Browse files
committed
slightly updated readme
1 parent effcb7c commit 58ecac6

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ if (mask1 & Value2) { // if Value2 flag is set
4040
```
4141
4242
## Description
43+
44+
**Disclaimer: docs are currently out of sync a little bit**
45+
4346
``` c++
4447
template <class E> class flags;
4548
```
@@ -56,7 +59,8 @@ underlying_type|The integer type that is used as representation of `flags`|Equiv
5659
#### Constructors and assignment operators
5760
Name |Description
5861
-----------------------------|-----------
59-
`flags()` |Default contructor (all flags are unset)
62+
`flags()` |Default contructor, keeps object uninitialized (note: object may contain garbage)
63+
`flags(empty_t)` |Unsets all flags
6064
`flags(flags::enum_type)` |Sets flag denoted by the parameter
6165
`flags(const flags&)` |Copy constructor
6266
`flags(flags&&)` |Move constructor

0 commit comments

Comments
 (0)