is_enum.qbk 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. [/
  2. Copyright 2007 John Maddock.
  3. Distributed under the Boost Software License, Version 1.0.
  4. (See accompanying file LICENSE_1_0.txt or copy at
  5. http://www.boost.org/LICENSE_1_0.txt).
  6. ]
  7. [section:is_enum is_enum]
  8. template <class T>
  9. struct is_enum : public __tof {};
  10. __inherit If T is a (possibly cv-qualified) enum type then inherits from __true_type,
  11. otherwise inherits from __false_type.
  12. __std_ref 3.9.2 and 7.2.
  13. __header ` #include <boost/type_traits/is_enum.hpp>` or ` #include <boost/type_traits.hpp>`
  14. [all_compilers]
  15. __examples
  16. [:Given: `enum my_enum { one, two };` ]
  17. [:`is_enum<my_enum>` inherits from `__true_type`.]
  18. [:`is_enum<my_enum const>::type` is the type `__true_type`.]
  19. [:`is_enum<my_enum>::value` is an integral constant
  20. expression that evaluates to /true/.]
  21. [:`is_enum<my_enum&>::value` is an integral constant
  22. expression that evaluates to /false/.]
  23. [:`is_enum<my_enum*>::value` is an integral constant
  24. expression that evaluates to /false/.]
  25. [:`is_enum<T>::value_type` is the type `bool`.]
  26. [endsect]