Improve compact_optional documentation

quicknir · quicknir · commit a1eff1b61880 · 2019-05-18T13:26:14.000-04:00
diff --git a/compact_optional.h b/compact_optional.h
@@ -18,6 +18,13 @@ constexpr bool is_enum_value(std::underlying_type_t<T> enum_integral) {
   }
   return false;
 }
+/*
+  A optional for enums that takes the same space as the underlying enum by
+  using an integer value that doesn't correspond to any enumerator to indicate
+  the "empty" state.
+
+  Requires c++14.
+ */
 
 /*
   Implementation note: this doesn't exactly implement the subset of the optional

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,13 @@ constexpr bool is_enum_value(std::underlying_type_t<T> enum_integral) {`
`18`	`18`	`}`
`19`	`19`	`return false;`
`20`	`20`	`}`
	`21`	`+/*`
	`22`	`+ A optional for enums that takes the same space as the underlying enum by`
	`23`	`+ using an integer value that doesn't correspond to any enumerator to indicate`
	`24`	`+ the "empty" state.`
	`25`	`+`
	`26`	`+ Requires c++14.`
	`27`	`+ */`
`21`	`28`
`22`	`29`	`/*`
`23`	`30`	`Implementation note: this doesn't exactly implement the subset of the optional`