Add more documentation to loggerPollingSpeed setting
This commit is contained in:
parent
770c9b5c6e
commit
4bbc1fd683
1 changed files with 6 additions and 2 deletions
|
@ -218,16 +218,20 @@ public final class EngineConfiguration extends Configuration {
|
|||
|
||||
/**
|
||||
* Contains how fast the logging thread will poll for queued messages.
|
||||
* This also causes messages to be buffered.
|
||||
* <p>
|
||||
* Only applies if {@code optimizeLogging} is turned on.
|
||||
* Values below {@code 1} will poll for queued messages as fast as it can.
|
||||
* This however has pretty much no benefit. Leave it at {@code 5}, it works quite well.
|
||||
*
|
||||
* @see #optimizeLogging
|
||||
* @since v1-alpha1
|
||||
* @since v1-alpha4
|
||||
* -- GETTER --
|
||||
* Gets the value for {@link #loggerPollingSpeed}.
|
||||
*
|
||||
* @return variable value
|
||||
* @see #loggerPollingSpeed
|
||||
* @since v1-alpha1
|
||||
* @since v1-alpha4
|
||||
*/
|
||||
private int loggerPollingSpeed;
|
||||
|
||||
|
|
Loading…
Reference in a new issue