diff --git a/hyper.h b/hyper.h index 268be99c..075bb225 100644 --- a/hyper.h +++ b/hyper.h @@ -21,26 +21,26 @@ #include #include "hyper_function.h" -/** the main namespace of HyperRogue */ +/** \brief 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. */ +/** \brief 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 */ +/** \brief placate GCC's overzealous -Wunused-result */ template void ignore(T&&) { } +/** \brief a simple static_cast for use with printf("%p") */ inline const void *voidp(const void *p) { - // a simple static_cast for use with printf("%p") return p; } -/** Is the value of first parameter equal to one of the remaining parameters? */ +/** \brief 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...); }