Re: [Boost-bugs] [Boost C++ Libraries] #8355: spsc_queue - Incorrect doc for push/pop array operations

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #8355: spsc_queue - Incorrect doc for push/pop array operations
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-03-31 09:27:28


#8355: spsc_queue - Incorrect doc for push/pop array operations
-------------------------------+--------------------------------------------
  Reporter: viboes | Owner: timblechmann
      Type: Bugs | Status: new
 Milestone: To Be Determined | Component: lockfree
   Version: Boost 1.53.0 | Severity: Cosmetic
Resolution: | Keywords:
-------------------------------+--------------------------------------------
Description changed by viboes:

Old description:

> The operations
>
> {{{
> template <size_type size>
> size_type push(T const (&t)[size]);
> template <size_type size>
> size_type pop(T (&ret)[size]);
> }}}
>

> are documented as
>
> {{{
> template<size_type size> size_type push(T const (&) t);
> template<size_type size> size_type pop(T const (&) t);
> }}}
>
> I don't know if this is a doxygen problem, but the doc should be updated
> to show the real prototype.
>
> Adding someting like the following would at least warm the user.
>

> {{{
> * \note Doxygen has some issues generating this prototype. The real
> prototype is:
> * \code
> * template <size_type size>
> * size_type push(T const (&t)[size]);
> * \endcode
> }}}
>
> and
>
> {{{
> * \note Doxygen has some issues generating this prototype. The real
> prototype is:
> * \code
> * template <size_type size>
> * size_type pop(T (&ret)[size]);
> * \endcode
> }}}

New description:

 The operations

 {{{
     template <size_type size>
     size_type push(T const (&t)[size]);
     template <size_type size>
     size_type pop(T (&ret)[size]);
 }}}


 are documented as

 {{{
 template<size_type size> size_type push(T const (&) t);
 template<size_type size> size_type pop(T (&) t);
 }}}

 I don't know if this is a doxygen problem, but the doc should be updated
 to show the real prototype.

 Adding something like the following would at least warm the user.


 {{{
      * \note Doxygen has some issues generating this prototype. The real
 prototype is:
      * \code
      * template <size_type size>
      * size_type push(T const (&t)[size]);
      * \endcode
 }}}

 and

 {{{
      * \note Doxygen has some issues generating this prototype. The real
 prototype is:
      * \code
      * template <size_type size>
      * size_type pop(T (&ret)[size]);
      * \endcode
 }}}

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

This archive was generated by hypermail 2.1.7 : 2017-02-16 18:50:12 UTC