Skip to content

Commit be58c6d

Browse files
committed
AbstractFifo: Improve docs
1 parent 60c34d3 commit be58c6d

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

modules/juce_core/containers/juce_AbstractFifo.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
namespace juce
3636
{
3737

38-
AbstractFifo::AbstractFifo (int capacity) noexcept : bufferSize (capacity)
38+
AbstractFifo::AbstractFifo (int backingBufferSize) noexcept : bufferSize (backingBufferSize)
3939
{
4040
jassert (bufferSize > 0);
4141
}

modules/juce_core/containers/juce_AbstractFifo.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,11 @@ class JUCE_API AbstractFifo
8585
{
8686
public:
8787
//==============================================================================
88-
/** Creates a FIFO to manage a buffer with the specified capacity. */
89-
AbstractFifo (int capacity) noexcept;
88+
/** Creates a FIFO to manage a buffer with the specified size.
89+
90+
The maximum number of items managed by the FIFO is 1 less than the buffer size.
91+
*/
92+
explicit AbstractFifo (int bufferSize) noexcept;
9093

9194
//==============================================================================
9295
/** Returns the total size of the buffer being managed. */
@@ -102,6 +105,7 @@ class JUCE_API AbstractFifo
102105
void reset() noexcept;
103106

104107
/** Changes the buffer's total size.
108+
105109
Note that this isn't thread-safe, so don't call it if there's any danger that it
106110
might overlap with a call to any other method in this class!
107111
*/

0 commit comments

Comments
 (0)