#34 circular_queue documentation bugs

[Caleb Epstein]

Perhaps I misunderstand this class, but the
documentation for circular_queue seems to be incomplete.

The Detailed Description says:

Detailed Description
template<typename T>
class adobe::circular_queue< T >

Template Parameters:

* T The queue's value type: the type of object
that is stored in the queue.
* Capacity The capacity for the queue. Must be
greater than 0.

But Capacity is *not* a template parameter.

There is a constructor that takes a size_t, but it
lives inside a #if !defined(ADOBE_NO_DOCUMENTATION)
block, so it isn't included in the documentation.

[Sean Parent]

Logged In: YES
user_id=1227609

You are correct - the documentation is out of sync with the implementation. I'll
try and get this fixed for the next release.
Seam

[Sean Parent]

Logged In: YES
user_id=1227609

Updated documentation submitted for 1.0.15.

[SourceForge Robot]

Logged In: YES
user_id=1312539

This Tracker item was closed automatically by the system. It was
previously set to a Pending status, and the original submitter
did not respond within 14 days (the time period specified by
the administrator of this Tracker).