From 8fd0ddb13c7b89df89275726d318b2990c7baa4b Mon Sep 17 00:00:00 2001
From: neargye <neargye@gmail.com>
Date: Mon, 17 Aug 2020 01:28:35 +0500
Subject: [PATCH] update example

---
 example/enum_flag_example.cpp | 26 +++++++++++++-------------
 example/example.cpp           |  4 ++--
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/example/enum_flag_example.cpp b/example/enum_flag_example.cpp
index 812a3fb..80eea9b 100644
--- a/example/enum_flag_example.cpp
+++ b/example/enum_flag_example.cpp
@@ -28,12 +28,12 @@
 enum class AnimalFlags : std::uint64_t { HasClaws = 1 << 10, CanFly = 1 << 20, EatsFish = 1 << 30, Endangered = std::uint64_t{1} << 40 };
 
 int main() {
-  // Enum variable to string name.
+  // Enum-flags variable to string name.
   AnimalFlags f1 = AnimalFlags::Endangered;
   auto f1_name = magic_enum::flags::enum_name(f1);
   std::cout << f1_name << std::endl; // Endangered
 
-  // String enum name sequence.
+  // String enum-flags name sequence.
   constexpr auto& names = magic_enum::flags::enum_names<AnimalFlags>();
   std::cout << "AnimalFlags names:";
   for (const auto& n : names) {
@@ -42,47 +42,47 @@ int main() {
   std::cout << std::endl;
   // AnimalFlags names: HasClaws CanFly EatsFish Endangered
 
-  // String name to enum value.
+  // String name to enum-flags value.
   auto f2 = magic_enum::flags::enum_cast<AnimalFlags>("EatsFish|CanFly");
   if (f2.has_value()) {
     std::cout << "EatsFish = " << magic_enum::flags::enum_integer(f2.value()) << std::endl; // CanFly|EatsFish = 1074790400
   }
 
-  // Integer value to enum value.
+  // Integer value to enum-flags value.
   auto f3 = magic_enum::flags::enum_cast<AnimalFlags>(1073742848);
   if (f3.has_value()) {
     std::cout << magic_enum::flags::enum_name(f3.value()) << " = " << magic_enum::flags::enum_integer(f3.value()) << std::endl; // HasClaws|EatsFish = 1073742848
   }
 
-  // Enum value to integer value.
+  // Enum-flags value to integer value.
   auto f4_integer = magic_enum::flags::enum_integer(AnimalFlags::HasClaws);
   std::cout << "HasClaws = " << f4_integer << std::endl; // HasClaws = 1024
 
-  using namespace magic_enum::flags::ostream_operators; // out-of-the-box ostream operator for all enums.
-  // ostream operator for enum.
+  using namespace magic_enum::flags::ostream_operators; // out-of-the-box ostream operator for enum-flags.
+  // Ostream operator for enum-flags.
   std::cout << f1 << " " << f2 << " " << f3 << std::endl; // Endangered CanFly|EatsFish HasClaws|EatsFish
 
-  // Number of enum values.
+  // Number of enum-flags values.
   std::cout << "AnimalFlags enum size: " << magic_enum::flags::enum_count<AnimalFlags>() << std::endl; // AnimalFlags enum size: 4
 
-  // Indexed access to enum value.
+  // Indexed access to enum-flags value.
   std::cout << "AnimalFlags[0] = " << magic_enum::flags::enum_value<AnimalFlags>(0) << std::endl; // AnimalFlags[0] = HasClaws
 
-  // Enum value sequence.
+  // Enum-flags value sequence.
   constexpr auto& values = magic_enum::flags::enum_values<AnimalFlags>();
   std::cout << "AnimalFlags values:";
   for (const auto& f : values) {
-    std::cout << " " << f; // ostream operator for enum.
+    std::cout << " " << f; // Ostream operator for enum-flags.
   }
   std::cout << std::endl;
   // AnimalFlags sequence: HasClaws CanFly EatsFish Endangered
 
-  using namespace magic_enum::flags::bitwise_operators; // out-of-the-box bitwise operators for all enums.
+  using namespace magic_enum::bitwise_operators; // out-of-the-box bitwise operators for all enums.
   // Support operators: ~, |, &, ^, |=, &=, ^=.
   AnimalFlags flag = AnimalFlags::HasClaws | AnimalFlags::CanFly;
   std::cout << flag << std::endl; // HasClaws|CanFly
 
-  // Enum pair (value enum, string enum name) sequence.
+  // Enum-flags pair (value, string name) sequence.
   constexpr auto& entries = magic_enum::flags::enum_entries<AnimalFlags>();
   std::cout << "AnimalFlags entries:";
   for (const auto& e : entries) {
diff --git a/example/example.cpp b/example/example.cpp
index bc41d26..e7011df 100644
--- a/example/example.cpp
+++ b/example/example.cpp
@@ -64,7 +64,7 @@ int main() {
   std::cout << "RED = " << c4_integer << std::endl; // RED = -10
 
   using namespace magic_enum::ostream_operators; // out-of-the-box ostream operator for all enums.
-  // ostream operator for enum.
+  // Ostream operator for enum.
   std::cout << "Color: " << c1 << " " << c2 << " " << c3 << std::endl; // Color: RED BLUE GREEN
 
   // Number of enum values.
@@ -77,7 +77,7 @@ int main() {
   constexpr auto& values = magic_enum::enum_values<Color>();
   std::cout << "Colors values:";
   for (const auto& c : values) {
-    std::cout << " " << c; // ostream operator for enum.
+    std::cout << " " << c; // Ostream operator for enum.
   }
   std::cout << std::endl;
   // Color sequence: RED BLUE GREEN