[Boost-bugs] [Boost C++ Libraries] #3768: Incomplete documentation for type_traits::extent and type_traits::rank

Subject: [Boost-bugs] [Boost C++ Libraries] #3768: Incomplete documentation for type_traits::extent and type_traits::rank
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2009-12-14 07:08:45

#3768: Incomplete documentation for type_traits::extent and type_traits::rank
------------------------------------------------+---------------------------
 Reporter:  Edward Diener <eld@…>               |       Owner:  johnmaddock
     Type:  Bugs                                |      Status:  new        
Milestone:  Boost 1.42.0                        |   Component:  type_traits
  Version:  Boost 1.41.0                        |    Severity:  Cosmetic   
 Keywords:  extent rank                         |  
------------------------------------------------+---------------------------
 The documentation for type_traits::extent is:

 "Inherits: Class template extent inherits from
 integral_constant<std::size_t, EXTENT(T,N)>, where EXTENT(T,N) is the
 number of elements in the N'th array dimention of type T.

 If T is not an array type, or if N > rank<T>::value, or if the N'th array
 bound is incomplete, then EXTENT(T,N) is zero."

 This does not explain what this type_traits is about.

 The documentation for type_traits::rank is:

 " Inherits: Class template rank inherits from
 integral_constant<std::size_t, RANK(T)>, where RANK(T) is the number of
 array dimensions in type T.

 If T is not an array type, then RANK(T) is zero. "

 This does not explain what this type_traits is about.

 Decent documentation for both of these would be welcome.

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