[Boost-bugs] [Boost C++ Libraries] #5885: Document mistake: is_union

Subject: [Boost-bugs] [Boost C++ Libraries] #5885: Document mistake: is_union
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-09-10 12:13:19

#5885: Document mistake: is_union
-------------------------------------------------+--------------------------
 Reporter:  Yuhki Ogasawara <y121516@…>          |       Owner:  johnmaddock
     Type:  Bugs                                 |      Status:  new        
Milestone:  To Be Determined                     |   Component:  type_traits
  Version:  Boost 1.47.0                         |    Severity:  Problem    
 Keywords:                                       |  
-------------------------------------------------+--------------------------
 http://www.boost.org/doc/libs/1_47_0/libs/type_traits/doc/html/boost_typetraits/reference/is_union.html

 The part of examples are wrong.
 {{{
     is_union<void> inherits from true_type.
     is_union<const void>::type is the type true_type.
     is_union<void>::value is an integral constant expression that
 evaluates to true.
 }}}
 I think the all of examples should be
 {{{
 Examples:
     Given: union my_union { };
     is_union<my_union> inherits from true_type.
     is_union<const my_union>::type is the type true_type.
     is_union<my_union>::value is an integral constant expression that
 evaluates to true.
     is_union<my_union*>::value is an integral constant expression that
 evaluates to false.
     is_union<T>::value_type is the type bool.
 }}}

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/5885>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.