diff --git a/hyper.h b/hyper.h index 7c119bcf..b17cac79 100644 --- a/hyper.h +++ b/hyper.h @@ -21,18 +21,21 @@ #include #include "hyper_function.h" +/** the main namespace of HyperRogue */ namespace hr { +/** A helper structure that acts as a boolean which is always false. Helpful when disabling stuff with compiler flags. */ struct always_false { operator bool() const { return false; }; bool operator = (bool b) const { return b; }; }; +/** placate GCC's overzealous -Wunused-result */ template void ignore(T&&) { - // placate GCC's overzealous -Wunused-result } +/** Is the value of first parameter equal to one of the remaining parameters? */ template bool among(T x, V y) { return x == y; } template bool among(T x, V y, U... u) { return x==y || among(x,u...); } diff --git a/reg3.cpp b/reg3.cpp index 2c0e9321..89d88754 100644 --- a/reg3.cpp +++ b/reg3.cpp @@ -20,6 +20,7 @@ namespace binary { hyperpoint deparabolic3(hyperpoint h); } +/** regular three-dimensional tessellations */ EX namespace reg3 { #if HDR