Opened 10 years ago
Last modified 10 years ago
#8355 new Bugs
spsc_queue - Incorrect doc for push/pop array operations
| Reported by: | viboes | Owned by: | timblechmann |
|---|---|---|---|
| Milestone: | To Be Determined | Component: | lockfree |
| Version: | Boost 1.53.0 | Severity: | Cosmetic |
| Keywords: | Cc: |
Description (last modified by )
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
Change History (2)
comment:1 by , 10 years ago
| Description: | modified (diff) |
|---|
comment:2 by , 10 years ago
Note:
See TracTickets
for help on using tickets.

yes, unfortunately this seems to be bug in doxygen. will see what happens if i add your comment.