mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

AbstractFifo: Improve docs

Browse source
This commit is contained in:
Tom Poole 2025-10-13 12:07:00 +01:00
parent 60c34d3ccb
commit be58c6de30
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/juce_core/containers/juce_AbstractFifo.cpp
View file

@ -35,7 +35,7 @@
namespace juce namespace juce
{ {
AbstractFifo::AbstractFifo (int capacity) noexcept : bufferSize (capacity) AbstractFifo::AbstractFifo (int backingBufferSize) noexcept : bufferSize (backingBufferSize)
{ {
jassert (bufferSize > 0); jassert (bufferSize > 0);
} }

8
modules/juce_core/containers/juce_AbstractFifo.h
View file

@ -85,8 +85,11 @@ class JUCE_API AbstractFifo
{ {
public: public:
//============================================================================== //==============================================================================
/** Creates a FIFO to manage a buffer with the specified capacity. */ /** Creates a FIFO to manage a buffer with the specified size.
AbstractFifo (int capacity) noexcept;
The maximum number of items managed by the FIFO is 1 less than the buffer size.
*/
explicit AbstractFifo (int bufferSize) noexcept;
//============================================================================== //==============================================================================
/** Returns the total size of the buffer being managed. */ /** Returns the total size of the buffer being managed. */
@ -102,6 +105,7 @@ public:
void reset() noexcept; void reset() noexcept;
/** Changes the buffer's total size. /** Changes the buffer's total size.
Note that this isn't thread-safe, so don't call it if there's any danger that it Note that this isn't thread-safe, so don't call it if there's any danger that it
might overlap with a call to any other method in this class! might overlap with a call to any other method in this class!
*/ */