(logging-log4cxx) branch async_appender_buffer_resize updated: Document the setBufferSize restriction

[swebb2066]

This is an automated email from the ASF dual-hosted git repository.

swebb2066 pushed a commit to branch async_appender_buffer_resize
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git


The following commit(s) were added to refs/heads/async_appender_buffer_resize 
by this push:
     new accdbeb3 Document the setBufferSize restriction
accdbeb3 is described below

commit accdbeb30f08a7753ebb66ff92328205b3dbc2eb
Author: Stephen Webb <swebb2...@gmail.com>
AuthorDate: Mon Mar 30 13:28:10 2026 +1100

    Document the setBufferSize restriction
---
 src/main/include/log4cxx/asyncappender.h | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/main/include/log4cxx/asyncappender.h 
b/src/main/include/log4cxx/asyncappender.h
index fe9ff01b..f00d89ba 100644
--- a/src/main/include/log4cxx/asyncappender.h
+++ b/src/main/include/log4cxx/asyncappender.h
@@ -204,11 +204,11 @@ class LOG4CXX_EXPORT AsyncAppender :
                void setLocationInfo(bool flag);
 
                /**
-               * The <b>BufferSize</b> option takes a non-negative integer 
value.
-               * This integer value determines the maximum size of the bounded
-               * buffer.
+               * Use \c newSize (a non-negative integer value) for
+               * the number of [logging events](@ref spi::LoggingEvent) the 
ring buffer can hold.
+               * The ring buffer size cannot be changed once the appender has 
received an event.
                * */
-               void setBufferSize(int size);
+               void setBufferSize(int newSize);
 
                /**
                 * Gets the current buffer size.
@@ -217,19 +217,19 @@ class LOG4CXX_EXPORT AsyncAppender :
                int getBufferSize() const;
 
                /**
-                * Sets whether appender should wait if there is no
-                * space available in the event buffer or immediately return.
+                * Use \c newValue for whether appender should block the 
calling thread
+                * if there is no space in the ring buffer.
                 *
-                * @param value true if appender should wait until available 
space in buffer.
+                * @param newValue true if appender should wait until space is 
available in the ring buffer.
                 */
-               void setBlocking(bool value);
+               void setBlocking(bool newValue);
 
                /**
-                * Gets whether appender should block calling thread when 
buffer is full.
+                * Gets whether appender should block calling thread when ring 
buffer is full.
                 * If false, messages will be counted by logger and a summary
-                * message appended after the contents of the buffer have been 
appended.
+                * message added after the buffered events have been appended.
                 *
-                * @return true if calling thread will be blocked when buffer 
is full.
+                * @return true if calling thread will be blocked when ring 
buffer is full.
                 */
                bool getBlocking() const;