This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a commit to branch update_web_site
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit 9d77d4b74a212090b64156370daa301a33c060d1
Author: Stephen Webb <swebb2...@gmail.com>
AuthorDate: Sun Aug 3 15:19:38 2025 +1000
Use doxygen 1.14 to get a more modern looking web site
---
admin/MailTemplate.Announce.txt | 12 +++++-----
admin/MailTemplate.Result.txt | 4 ++--
admin/MailTemplate.txt | 6 ++---
admin/release-review-instructions.md | 16 ++++++++-----
admin/releasing.md | 28 +++++++++++-----------
admin/staging.md | 20 ++++++++--------
admin/validate-release.ps1 | 2 +-
admin/validate-release.sh | 2 +-
src/main/include/log4cxx/appenderskeleton.h | 6 ++---
src/main/include/log4cxx/asyncappender.h | 8 +++----
src/main/include/log4cxx/consoleappender.h | 6 ++---
src/main/include/log4cxx/db/dbappender.h | 14 +++++------
src/main/include/log4cxx/db/odbcappender.h | 16 ++++++-------
src/main/include/log4cxx/fileappender.h | 16 ++++++-------
src/main/include/log4cxx/filter/levelmatchfilter.h | 8 +++----
src/main/include/log4cxx/filter/levelrangefilter.h | 10 ++++----
.../include/log4cxx/filter/locationinfofilter.h | 12 +++++-----
.../include/log4cxx/filter/loggermatchfilter.h | 8 +++----
src/main/include/log4cxx/filter/mapfilter.h | 10 ++++----
.../include/log4cxx/filter/stringmatchfilter.h | 8 +++----
src/main/include/log4cxx/fmtlayout.h | 6 ++---
.../include/log4cxx/helpers/onlyonceerrorhandler.h | 6 ++---
src/main/include/log4cxx/htmllayout.h | 8 +++----
src/main/include/log4cxx/jsonlayout.h | 10 ++++----
src/main/include/log4cxx/net/smtpappender.h | 28 +++++++++++-----------
.../include/log4cxx/net/socketappenderskeleton.h | 10 ++++----
src/main/include/log4cxx/net/syslogappender.h | 10 ++++----
src/main/include/log4cxx/net/telnetappender.h | 14 +++++------
src/main/include/log4cxx/nt/nteventlogappender.h | 10 ++++----
src/main/include/log4cxx/patternlayout.h | 18 +++++++-------
.../log4cxx/rolling/filterbasedtriggeringpolicy.h | 6 ++---
.../log4cxx/rolling/fixedwindowrollingpolicy.h | 10 ++++----
.../log4cxx/rolling/manualtriggeringpolicy.h | 6 ++---
.../include/log4cxx/rolling/rollingfileappender.h | 10 ++++----
.../include/log4cxx/rolling/rollingpolicybase.h | 8 +++----
.../log4cxx/rolling/sizebasedtriggeringpolicy.h | 6 ++---
src/main/include/log4cxx/spi/filter.h | 6 ++---
src/main/include/log4cxx/writerappender.h | 6 ++---
src/main/include/log4cxx/xml/xmllayout.h | 8 +++----
39 files changed, 201 insertions(+), 197 deletions(-)
diff --git a/admin/MailTemplate.Announce.txt b/admin/MailTemplate.Announce.txt
index 1232a349..6450f6c8 100644
--- a/admin/MailTemplate.Announce.txt
+++ b/admin/MailTemplate.Announce.txt
@@ -1,18 +1,18 @@
To: annou...@apache.org, d...@logging.apache.org
-Subject: [ANNOUNCE] Apache log4cxx 1.4.0 released
+Subject: [ANNOUNCE] Apache log4cxx 1.6.0 released
Hi,
-The Apache log4cxx team is pleased to announce the 1.4.0 release.
+The Apache log4cxx team is pleased to announce the 1.6.0 release.
For the list of new features and issues corrected, see:
-https://logging.apache.org/log4cxx/1.4.0/changelog.html#rel_1_4_0
+https://logging.apache.org/log4cxx/1.6.0/changelog.html#rel_1_6_0
For official release downloads, see:
-https://logging.apache.org/log4cxx/1.4.0/download.html
+https://logging.apache.org/log4cxx/1.6.0/download.html
For instructions on building Log4cxx, see:
-https://logging.apache.org/log4cxx/1.4.0/build.html
+https://logging.apache.org/log4cxx/1.6.0/build.html
All other information is available on the Log4cxx project website:
-https://logging.apache.org/log4cxx/1.4.0
+https://logging.apache.org/log4cxx/1.6.0
diff --git a/admin/MailTemplate.Result.txt b/admin/MailTemplate.Result.txt
index 6a21818d..e5586620 100644
--- a/admin/MailTemplate.Result.txt
+++ b/admin/MailTemplate.Result.txt
@@ -1,5 +1,5 @@
To: d...@logging.apache.org
-Subject: [RESULT][VOTE] Release Apache Log4cxx 1.4.0
+Subject: [RESULT][VOTE] Release Apache Log4cxx 1.6.0
and here is my +1.
@@ -9,6 +9,6 @@ I will continue the release process.
Stephen
---------------------------------------------------------------------------------------------------
-This is a vote to release the Apache Log4cxx 1.4.0.
+This is a vote to release the Apache Log4cxx 1.6.0.
...
\ No newline at end of file
diff --git a/admin/MailTemplate.txt b/admin/MailTemplate.txt
index 5e14951c..64c92b7b 100644
--- a/admin/MailTemplate.txt
+++ b/admin/MailTemplate.txt
@@ -1,9 +1,9 @@
To: d...@logging.apache.org
-Subject: [VOTE] Release Apache Log4cxx 1.4.0
+Subject: [VOTE] Release Apache Log4cxx 1.6.0
-This is a vote to release the Apache Log4cxx 1.4.0.
+This is a vote to release the Apache Log4cxx 1.6.0.
-Website: https://logging.staged.apache.org/log4cxx/1.4.0/changelog.html
+Website: https://logging.staged.apache.org/log4cxx/1.6.0/changelog.html
GitHub: https://github.com/apache/logging-log4cxx
Commit: <todo insert>
Distribution: https://dist.apache.org/repos/dist/dev/logging/log4cxx/
diff --git a/admin/release-review-instructions.md
b/admin/release-review-instructions.md
index b1e7c978..8a436b92 100644
--- a/admin/release-review-instructions.md
+++ b/admin/release-review-instructions.md
@@ -3,7 +3,7 @@ Reviewing a Log4cxx release
The review should confirm the uploaded source code is not corrupt and
is identical to the package generated by the Github action.
-The steps below use version 1.4.0 as an example.
+The steps below use version 1.6.0 as an example.
Prerequisites
----------
@@ -30,10 +30,14 @@ Steps
- Linux, MacOS: `validate-release.sh`
- Windows: `validate-release.ps1`
- Run the script
+ - Linux, MacOS:
+ - `sh validate-release.sh 1.6.0`
+ - Windows:
+ - `.\validate-release.ps1 1.6.0`
- For success, the final output line needs to include:
- `100% tests passed, 0 tests failed out of 63`
1. Download the packaged release files from Github
- - Open https://github.com/apache/logging-log4cxx/commits/v1.4.0-RC1 in
your web browser
+ - Open https://github.com/apache/logging-log4cxx/commits/v1.6.0-RC1 in
your web browser
- Click the green tick mark on the top commit
- The `All checks have passed` pop-up window will display
- Click the "Details" link on the row next to `Generate release files /
Package code for release`
@@ -44,16 +48,16 @@ Steps
- The browser will download the file `release_files.zip` onto your
system
1. Confirm the artifacts were sourced from Github using these commands
- Linux, MacOS (bash):
- - `cd /tmp/log4cxx-1.4.0`
+ - `cd /tmp/log4cxx-1.6.0`
- `unzip $HOME/Downloads/release_files.zip -d github`
- - `ARCHIVE=apache-log4cxx-1.4.0`
+ - `ARCHIVE=apache-log4cxx-1.6.0`
- `for TYPE in tar.gz zip; do`
- `diff {,github/}$ARCHIVE.$TYPE.sha512 && echo "$ARCHIVE.$TYPE.sha512:
OK"`
- `done`
- Windows (powershell):
- - `Set-Location -Path "${ENV:TEMP}\log4cxx-1.4.0"`
+ - `Set-Location -Path "${ENV:TEMP}\log4cxx-1.6.0"`
- `Expand-Archive -Path "${ENV:HOMEPATH}\Downloads\release_files.zip"
-DestinationPath "github"`
- - `$ARCHIVE="apache-log4cxx-1.4.0"`
+ - `$ARCHIVE="apache-log4cxx-1.6.0"`
- `foreach ($TYPE in @("tar.gz", "zip")) {`
- `` if (@(Get-Content -Path "$ARCHIVE.$TYPE.sha512")[0]` ``
- `-eq @(Get-Content -Path "github\$ARCHIVE.$TYPE.sha512")[0]) {`
diff --git a/admin/releasing.md b/admin/releasing.md
index aa280466..421044b3 100644
--- a/admin/releasing.md
+++ b/admin/releasing.md
@@ -2,7 +2,7 @@ Releasing a Log4cxx version
===================
This document lists the steps that must be performed to release Log4cxx
-using 1.4.0 as the example.
+using 1.6.0 as the example.
Prerequisites
----------
@@ -19,19 +19,19 @@ Steps
1. Tag HEAD as the release candidate
- `git checkout master`
- `git pull`
- - `git tag v1.4.0-RC1`
- - `git push origin tag v1.4.0-RC1`
+ - `git tag v1.6.0-RC1`
+ - `git push origin tag v1.6.0-RC1`
1. Remove the old artifacts from svn
- `svn co https://dist.apache.org/repos/dist/dev/logging -N
apache-dist-logging-dev`
- `cd apache-dist-logging-dev`
- `svn up log4cxx`
- `cd log4cxx`
- `svn delete *`
- - `mkdir 1.4.0`
- - `svn add 1.4.0`
- - `cd 1.4.0`
+ - `mkdir 1.6.0`
+ - `svn add 1.6.0`
+ - `cd 1.6.0`
1. Download the packaged release files from Github
- - Open https://github.com/apache/logging-log4cxx/commits/v1.4.0-RC1 in
your web browser
+ - Open https://github.com/apache/logging-log4cxx/commits/v1.6.0-RC1 in
your web browser
- Click the green tick mark on the top commit
- The `All checks have passed` pop-up window will display
- Click the "Details" link on the row next to `Generate release files /
Package code for release`
@@ -40,11 +40,11 @@ Steps
- The numbered steps will display
- Click the link next to `Artifact download URL:`
- The browser will download the file `release_files.zip` onto your
system
-1. Unpack the release files using these commands (with
`apache-dist-logging-dev/log4cxx/1.4.0` as the working directory)
+1. Unpack the release files using these commands (with
`apache-dist-logging-dev/log4cxx/1.6.0` as the working directory)
- `unzip "$HOME/Downloads/release_files.zip"`
-1. Send the new artifacts to svn (with `apache-dist-logging-dev/log4cxx/1.4.0`
as the working directory)
+1. Send the new artifacts to svn (with `apache-dist-logging-dev/log4cxx/1.6.0`
as the working directory)
- `svn add *`
- - `svn commit -m 'log4cxx 1.4.0'`
+ - `svn commit -m 'log4cxx 1.6.0'`
- check https://dist.apache.org/repos/dist/dev/logging/log4cxx
1. Raise a vote on the mailing list (d...@logging.apache.org)
- Using [this template](MailTemplate.txt)
@@ -53,11 +53,11 @@ Steps
1. When the vote has 3 or more +1's, announce the result
- Using [this template](MailTemplate.Result.txt)
1. Get artifacts up to https://downloads.apache.org/logging/log4cxx/
- - `svn move -m "Release log4cxx 1.4.0"
https://dist.apache.org/repos/dist/dev/logging/log4cxx/1.4.0
https://dist.apache.org/repos/dist/release/logging/log4cxx/`
+ - `svn move -m "Release log4cxx 1.6.0"
https://dist.apache.org/repos/dist/dev/logging/log4cxx/1.6.0
https://dist.apache.org/repos/dist/release/logging/log4cxx/`
1. Tag the released version
- - `git checkout v1.4.0-RC1`
- - `git tag rel/v1.4.0`
- - `git push origin tag rel/v1.4.0`
+ - `git checkout v1.6.0-RC1`
+ - `git tag rel/v1.6.0`
+ - `git push origin tag rel/v1.6.0`
1. Enter the release date in `src/site/markdown/change-report-gh.md`
- Commit the change
- Update the staged web site using [the update procedure](staging.md)
diff --git a/admin/staging.md b/admin/staging.md
index b52d3008..7c915915 100644
--- a/admin/staging.md
+++ b/admin/staging.md
@@ -2,13 +2,13 @@ Updating the Log4cxx web site
===================
This document describes the steps used to update Log4cxx web site
-using 1.4.0 as an example Log4cxx version.
+using 1.6.0 as an example Log4cxx version.
Prerequisites
----------
* The documentation changes have been committed to the log4cxx source code
repository
-* Doxygen 1.9.6 in available on your system
+* Doxygen 1.14.0 in available on your system
* APR and APR-Util are available on your system
Steps to update the Log4cxx web site
@@ -23,9 +23,9 @@ Steps to update the Log4cxx web site
- `cd /tmp/log4cxx-site`
- `git checkout asf-staging`
1. Use the newly generated files for the web site documentation
- - `git rm -r 1.4.0`
- - `mv /tmp/build/src/site/html 1.4.0`
- - `git add 1.4.0`
+ - `git rm -r 1.6.0`
+ - `mv /tmp/build/src/site/html 1.6.0`
+ - `git add 1.6.0`
1. Push the `asf-staging` branch to Github and wait a bit
- `git commit -m "Improved the ... documentation"`
- `git push origin asf-staging`
@@ -45,18 +45,18 @@ Steps to add a new version to the Log4cxx web site
- `cd /tmp/log4cxx-site`
- `git checkout asf-staging`
1. Use the newly generated files for the web site documentation
- - `mv /tmp/build/src/site/html /tmp/log4cxx-site/1.4.0`
- - `git add 1.4.0`
+ - `mv /tmp/build/src/site/html /tmp/log4cxx-site/1.6.0`
+ - `git add 1.6.0`
1. Update the symbolic links in the base of the web site working directory
- `cd /tmp/log4cxx-site`
- `rm old_stable`
- - `ln -s 1.2.0 old_stable`
+ - `ln -s 1.5.0 old_stable`
- `git add old_stable`
1. Update `.htaccess` so the final `RewriteRule` redirects to the new version
- - `RewriteRule ^(.*)$ /log4cxx/1.4.0/$1 [R=temp,L]`
+ - `RewriteRule ^(.*)$ /log4cxx/1.6.0/$1 [R=temp,L]`
- `git add .htaccess`
1. Push the `asf-staging` branch to github and wait a bit
- - `git commit -m "Add the 1.4.0 documentation"`
+ - `git commit -m "Add the 1.6.0 documentation"`
- `git push origin asf-staging`
1. Check https://logging.staged.apache.org/log4cxx (after a minute or two)
- Are you seeing the new pages?
diff --git a/admin/validate-release.ps1 b/admin/validate-release.ps1
index 3b3822aa..d48b324a 100644
--- a/admin/validate-release.ps1
+++ b/admin/validate-release.ps1
@@ -1,7 +1,7 @@
# Allow the version to be provided as a parameter
param ( [string]$VERSION )
-if (-not $VERSION) { $VERSION = "1.4.0" }
+if (-not $VERSION) { $VERSION = "1.6.0" }
$STAGE="dev"
#$STAGE="release"
diff --git a/admin/validate-release.sh b/admin/validate-release.sh
index 88ede8fa..9832ee75 100644
--- a/admin/validate-release.sh
+++ b/admin/validate-release.sh
@@ -4,7 +4,7 @@ set -e
VERSION=$1
if [ -z "$VERSION" ] ; then
- VERSION=1.4.0
+ VERSION=1.6.0
fi
if [ -z "$STAGE" ] ; then
diff --git a/src/main/include/log4cxx/appenderskeleton.h
b/src/main/include/log4cxx/appenderskeleton.h
index f0b8926c..5679a3e8 100644
--- a/src/main/include/log4cxx/appenderskeleton.h
+++ b/src/main/include/log4cxx/appenderskeleton.h
@@ -80,9 +80,9 @@ class LOG4CXX_EXPORT AppenderSkeleton :
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Threshold | Trace,Debug,Info,Warn,Error,Fatal,Off,All | All
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Threshold | Trace,Debug,Info,Warn,Error,Fatal,Off,All | All |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/asyncappender.h
b/src/main/include/log4cxx/asyncappender.h
index c8386f6b..21af7779 100644
--- a/src/main/include/log4cxx/asyncappender.h
+++ b/src/main/include/log4cxx/asyncappender.h
@@ -219,10 +219,10 @@ class LOG4CXX_EXPORT AsyncAppender :
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- BufferSize | int | 128
- Blocking | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ BufferSize | int | 128 |
+ Blocking | True,False | True |
\sa AppenderSkeleton::setOption()
*/
diff --git a/src/main/include/log4cxx/consoleappender.h
b/src/main/include/log4cxx/consoleappender.h
index 3871670a..328ea809 100644
--- a/src/main/include/log4cxx/consoleappender.h
+++ b/src/main/include/log4cxx/consoleappender.h
@@ -91,9 +91,9 @@ class LOG4CXX_EXPORT ConsoleAppender : public WriterAppender
/**
\copybrief WriterAppender::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Target | System.err,System.out | System.out
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Target | System.err,System.out | System.out |
\sa WriterAppender::setOption()
*/
diff --git a/src/main/include/log4cxx/db/dbappender.h
b/src/main/include/log4cxx/db/dbappender.h
index cb6be492..ce27a52c 100644
--- a/src/main/include/log4cxx/db/dbappender.h
+++ b/src/main/include/log4cxx/db/dbappender.h
@@ -125,13 +125,13 @@ class LOG4CXX_EXPORT DBAppender : public AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- DriverName | {any} | -
- DriverParams | {any} | -
- DatabaseName | {any} | -
- SQL | {any} | -
- ColumnMapping | (\ref rep "^") | -
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ DriverName | {any} | - |
+ DriverParams | {any} | - |
+ DatabaseName | {any} | - |
+ SQL | {any} | - |
+ ColumnMapping | (\ref rep "^") | - |
\anchor rep (^) One value for each '%%' character in the SQL
value.
\sa AppenderSkeleton::setOption()
diff --git a/src/main/include/log4cxx/db/odbcappender.h
b/src/main/include/log4cxx/db/odbcappender.h
index 0cb97d25..8aa496e4 100644
--- a/src/main/include/log4cxx/db/odbcappender.h
+++ b/src/main/include/log4cxx/db/odbcappender.h
@@ -159,14 +159,14 @@ class LOG4CXX_EXPORT ODBCAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- BufferSize | {int} | 1
- ConnectionString | {any} | -
- URL | {any} | -
- DSN | {any} | -
- User | {any} | -
- Password | {any} | -
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ BufferSize | {int} | 1 |
+ ConnectionString | {any} | - |
+ URL | {any} | - |
+ DSN | {any} | - |
+ User | {any} | - |
+ Password | {any} | - |
SQL | {any} | -
ColumnMapping | (\ref colName "^") | -
diff --git a/src/main/include/log4cxx/fileappender.h
b/src/main/include/log4cxx/fileappender.h
index 10722c07..eb72f58d 100644
--- a/src/main/include/log4cxx/fileappender.h
+++ b/src/main/include/log4cxx/fileappender.h
@@ -128,14 +128,14 @@ class LOG4CXX_EXPORT FileAppender : public WriterAppender
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- FileName | {any} | -
- Append | True,False | True
- BufferedIO | True,False | False
- BufferedSeconds | {any} | 5
- ImmediateFlush | True,False | False
- BufferSize | (\ref fileSz1 "1") | 8 KB
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ FileName | {any} | - |
+ Append | True,False | True |
+ BufferedIO | True,False | False |
+ BufferedSeconds | {any} | 5 |
+ ImmediateFlush | True,False | False |
+ BufferSize | (\ref fileSz1 "1") | 8 KB |
\anchor fileSz1 (1) An integer in the range 0 - 2^63.
You can specify the value with the suffixes "KB", "MB" or "GB"
so that the integer is
diff --git a/src/main/include/log4cxx/filter/levelmatchfilter.h
b/src/main/include/log4cxx/filter/levelmatchfilter.h
index 24a54d1a..9acdf302 100644
--- a/src/main/include/log4cxx/filter/levelmatchfilter.h
+++ b/src/main/include/log4cxx/filter/levelmatchfilter.h
@@ -58,10 +58,10 @@ class LOG4CXX_EXPORT LevelMatchFilter : public spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- LevelToMatch | (\ref validLevel "1") | -
- AcceptOnMatch | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ LevelToMatch | (\ref validLevel "1") | - |
+ AcceptOnMatch | True,False | True |
\anchor validLevel (1) One of Trace, Debug, Info, Warn, Error,
Fatal, Off, All
or a custom level in which case it is of the form
<code>{levelName}#{registeredClassName}</code>.
diff --git a/src/main/include/log4cxx/filter/levelrangefilter.h
b/src/main/include/log4cxx/filter/levelrangefilter.h
index b00d023c..ca7e2fd6 100644
--- a/src/main/include/log4cxx/filter/levelrangefilter.h
+++ b/src/main/include/log4cxx/filter/levelrangefilter.h
@@ -72,11 +72,11 @@ class LOG4CXX_EXPORT LevelRangeFilter : public spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- LevelMin | (\ref validLevels "1") | ALL
- LevelMax | (\ref validLevels "1") | OFF
- AcceptOnMatch | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ LevelMin | (\ref validLevels "1") | ALL |
+ LevelMax | (\ref validLevels "1") | OFF |
+ AcceptOnMatch | True,False | True |
\anchor validLevels (1). One of "Trace", "Debug", "Info",
"Warn", "Error", "Fatal", "Off", "All"
or a custom level in which case it is of the form
<code>{levelName}#{registeredClassName}</code>.
diff --git a/src/main/include/log4cxx/filter/locationinfofilter.h
b/src/main/include/log4cxx/filter/locationinfofilter.h
index 67f2e048..894876ff 100644
--- a/src/main/include/log4cxx/filter/locationinfofilter.h
+++ b/src/main/include/log4cxx/filter/locationinfofilter.h
@@ -55,12 +55,12 @@ class LOG4CXX_EXPORT LocationInfoFilter: public
LOG4CXX_NS::spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Method | {any} | -
- LineNumber | {int} | -
- Operator | (\ref andOrAny "1") | Or
- AcceptOnMatch | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Method | {any} | - |
+ LineNumber | {int} | - |
+ Operator | (\ref andOrAny "1") | Or |
+ AcceptOnMatch | True,False | True |
\anchor andOrAny (1) If "And", both method name and line number
must match,
otherwise either method name or line number match.
diff --git a/src/main/include/log4cxx/filter/loggermatchfilter.h
b/src/main/include/log4cxx/filter/loggermatchfilter.h
index a03f6d70..ba9c2952 100644
--- a/src/main/include/log4cxx/filter/loggermatchfilter.h
+++ b/src/main/include/log4cxx/filter/loggermatchfilter.h
@@ -61,10 +61,10 @@ class LOG4CXX_EXPORT LoggerMatchFilter : public spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- LoggerToMatch | {any} | root
- AcceptOnMatch | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ LoggerToMatch | {any} | root |
+ AcceptOnMatch | True,False | True |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/filter/mapfilter.h
b/src/main/include/log4cxx/filter/mapfilter.h
index c29573a2..17b58dc1 100644
--- a/src/main/include/log4cxx/filter/mapfilter.h
+++ b/src/main/include/log4cxx/filter/mapfilter.h
@@ -58,11 +58,11 @@ class LOG4CXX_EXPORT MapFilter: public
LOG4CXX_NS::spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Operator | (\ref andOrOne "1") | Or
- AcceptOnMatch | True,False | True
- {anyKey} | {anyValue} | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Operator | (\ref andOrOne "1") | Or |
+ AcceptOnMatch | True,False | True |
+ {anyKey} | {anyValue} | - |
\anchor andOrOne (1) If "And", the MDC must contain all
configured key-value pairs,
otherwise only one configured key-value pair needs to match.
diff --git a/src/main/include/log4cxx/filter/stringmatchfilter.h
b/src/main/include/log4cxx/filter/stringmatchfilter.h
index 7d6eeef7..a77b4c05 100644
--- a/src/main/include/log4cxx/filter/stringmatchfilter.h
+++ b/src/main/include/log4cxx/filter/stringmatchfilter.h
@@ -64,10 +64,10 @@ class LOG4CXX_EXPORT StringMatchFilter : public spi::Filter
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- StringToMatch | {any} | -
- AcceptOnMatch | True,False | True
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ StringToMatch | {any} | - |
+ AcceptOnMatch | True,False | True |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/fmtlayout.h
b/src/main/include/log4cxx/fmtlayout.h
index d88d10a6..fdcd386d 100644
--- a/src/main/include/log4cxx/fmtlayout.h
+++ b/src/main/include/log4cxx/fmtlayout.h
@@ -265,9 +265,9 @@ class LOG4CXX_EXPORT FMTLayout : public Layout
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- ConversionPattern | {any} | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ ConversionPattern | {any} | - |
*/
void setOption(const LogString& /* option */,
diff --git a/src/main/include/log4cxx/helpers/onlyonceerrorhandler.h
b/src/main/include/log4cxx/helpers/onlyonceerrorhandler.h
index 52ac5108..21111668 100644
--- a/src/main/include/log4cxx/helpers/onlyonceerrorhandler.h
+++ b/src/main/include/log4cxx/helpers/onlyonceerrorhandler.h
@@ -74,9 +74,9 @@ class LOG4CXX_EXPORT OnlyOnceErrorHandler :
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- - | - | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ - | - | - |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/htmllayout.h
b/src/main/include/log4cxx/htmllayout.h
index 8d0e60b6..0f72225f 100644
--- a/src/main/include/log4cxx/htmllayout.h
+++ b/src/main/include/log4cxx/htmllayout.h
@@ -88,10 +88,10 @@ class LOG4CXX_EXPORT HTMLLayout : public Layout
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Title | {any} | Log4cxx Log Messages
- LocationInfo | True,False | False
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Title | {any} | Log4cxx Log Messages |
+ LocationInfo | True,False | False |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/jsonlayout.h
b/src/main/include/log4cxx/jsonlayout.h
index fdc626b7..31e47c14 100644
--- a/src/main/include/log4cxx/jsonlayout.h
+++ b/src/main/include/log4cxx/jsonlayout.h
@@ -110,11 +110,11 @@ class LOG4CXX_EXPORT JSONLayout : public Layout
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- LocationInfo | True,False | false
- ThreadInfo | True,False | false
- PrettyPrint | True,False | false
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ LocationInfo | True,False | false |
+ ThreadInfo | True,False | false |
+ PrettyPrint | True,False | false |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/net/smtpappender.h
b/src/main/include/log4cxx/net/smtpappender.h
index 6282b484..e9059ee1 100644
--- a/src/main/include/log4cxx/net/smtpappender.h
+++ b/src/main/include/log4cxx/net/smtpappender.h
@@ -108,20 +108,20 @@ class LOG4CXX_EXPORT SMTPAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- smtpHost | {any} | -
- smtpPort | {int} | 25
- smtpUserName | {any} | -
- smtpPassword | {any} | -
- from | (\ref asciiCheck "1") | -
- to | (\ref asciiCheck "1") | -
- cc | (\ref asciiCheck "1") | -
- bcc | (\ref asciiCheck "1") | -
- subject | {any} | -
- subject | {any} | -
- buffersize | {int} | 512
- evaluatorClass | (\ref AppenderSkeleton "2") | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ smtpHost | {any} | - |
+ smtpPort | {int} | 25 |
+ smtpUserName | {any} | - |
+ smtpPassword | {any} | - |
+ from | (\ref asciiCheck "1") | - |
+ to | (\ref asciiCheck "1") | - |
+ cc | (\ref asciiCheck "1") | - |
+ bcc | (\ref asciiCheck "1") | - |
+ subject | {any} | - |
+ subject | {any} | - |
+ buffersize | {int} | 512 |
+ evaluatorClass | (\ref AppenderSkeleton "2") | - |
\anchor asciiCheck (1) Only ASCII charaters
diff --git a/src/main/include/log4cxx/net/socketappenderskeleton.h
b/src/main/include/log4cxx/net/socketappenderskeleton.h
index 0a166738..ea45b0ab 100644
--- a/src/main/include/log4cxx/net/socketappenderskeleton.h
+++ b/src/main/include/log4cxx/net/socketappenderskeleton.h
@@ -127,11 +127,11 @@ class LOG4CXX_EXPORT SocketAppenderSkeleton : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- RemoteHost | (\ref inetAddress "1") | -
- Port | {int} | (\ref defaultPort "2")
- LocationInfo | True,False | False
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ RemoteHost | (\ref inetAddress "1") | - |
+ Port | {int} | (\ref defaultPort "2") |
+ LocationInfo | True,False | False |
\anchor inetAddress (1) A valid internet address.
diff --git a/src/main/include/log4cxx/net/syslogappender.h
b/src/main/include/log4cxx/net/syslogappender.h
index 26a290f4..e4c2e808 100644
--- a/src/main/include/log4cxx/net/syslogappender.h
+++ b/src/main/include/log4cxx/net/syslogappender.h
@@ -85,11 +85,11 @@ class LOG4CXX_EXPORT SyslogAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- SysLogHost | (\ref sysLogAddress "1") | -
- Facility | (\ref facility "2") | -
- MaxMessageLength | {int} | 1024
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ SysLogHost | (\ref sysLogAddress "1") | - |
+ Facility | (\ref facility "2") | - |
+ MaxMessageLength | {int} | 1024 |
\anchor sysLogAddress (1) A valid internet address, optionally
with the port number as a suffix after a ':'.
diff --git a/src/main/include/log4cxx/net/telnetappender.h
b/src/main/include/log4cxx/net/telnetappender.h
index 12483b3f..ce5985af 100644
--- a/src/main/include/log4cxx/net/telnetappender.h
+++ b/src/main/include/log4cxx/net/telnetappender.h
@@ -95,13 +95,13 @@ class LOG4CXX_EXPORT TelnetAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Port | {int} | 23
- Hostname | name or numeric address |
- MaxConnections | {int} | 20
- Encoding |
C,UTF-8,UTF-16,UTF-16BE,UTF-16LE,646,US-ASCII,ISO646-US,ANSI_X3.4-1968,ISO-8859-1,ISO-LATIN-1
| UTF-8
- ReuseAddress | True,False | False
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Port | {int} | 23 |
+ Hostname | name or numeric address | - |
+ MaxConnections | {int} | 20 |
+ Encoding |
C,UTF-8,UTF-16,UTF-16BE,UTF-16LE,646,US-ASCII,ISO646-US,ANSI_X3.4-1968,ISO-8859-1,ISO-LATIN-1
| UTF-8 |
+ ReuseAddress | True,False | False |
\sa AppenderSkeleton::setOption()
*/
diff --git a/src/main/include/log4cxx/nt/nteventlogappender.h
b/src/main/include/log4cxx/nt/nteventlogappender.h
index 0cb21e90..dc998708 100644
--- a/src/main/include/log4cxx/nt/nteventlogappender.h
+++ b/src/main/include/log4cxx/nt/nteventlogappender.h
@@ -53,11 +53,11 @@ class LOG4CXX_EXPORT NTEventLogAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Server | (\ref winapi "1") | NULL
- Source | (\ref winapi "1") | -
- Log | (\ref eventLog "2") | Application
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Server | (\ref winapi "1") | NULL |
+ Source | (\ref winapi "1") | - |
+ Log | (\ref eventLog "2") | Application |
\anchor winapi (1) Passed to the Win32 API method <a
href="https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-registereventsourcew";>RegisterEventSource</a>.
diff --git a/src/main/include/log4cxx/patternlayout.h
b/src/main/include/log4cxx/patternlayout.h
index 7420266d..e11917bf 100644
--- a/src/main/include/log4cxx/patternlayout.h
+++ b/src/main/include/log4cxx/patternlayout.h
@@ -489,15 +489,15 @@ class LOG4CXX_EXPORT PatternLayout : public Layout
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- ConversionPattern | {any} | \%m\%n
- FatalColor | (\ref validColors "1") | magenta
- ErrorColor | (\ref validColors "1") | red
- WarnColor | (\ref validColors "1") | yellow
- InfoColor | (\ref validColors "1") | green
- DebugColor | (\ref validColors "1") | cyan
- TraceColor | (\ref validColors "1") | blue
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ ConversionPattern | {any} | \%m\%n |
+ FatalColor | (\ref validColors "1") | magenta |
+ ErrorColor | (\ref validColors "1") | red |
+ WarnColor | (\ref validColors "1") | yellow |
+ InfoColor | (\ref validColors "1") | green |
+ DebugColor | (\ref validColors "1") | cyan |
+ TraceColor | (\ref validColors "1") | blue |
\anchor validColors (1) The word <code>None</code> or
<a href="https://en.wikipedia.org/wiki/ANSI_escape_code";>valid
ANSI escape sequence</a>.
diff --git a/src/main/include/log4cxx/rolling/filterbasedtriggeringpolicy.h
b/src/main/include/log4cxx/rolling/filterbasedtriggeringpolicy.h
index de7b22f5..8ff908ee 100644
--- a/src/main/include/log4cxx/rolling/filterbasedtriggeringpolicy.h
+++ b/src/main/include/log4cxx/rolling/filterbasedtriggeringpolicy.h
@@ -110,9 +110,9 @@ class LOG4CXX_EXPORT FilterBasedTriggeringPolicy : public
TriggeringPolicy
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- - | - | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ - | - | - |
*/
void setOption(const LogString& option, const LogString& value)
override;
};
diff --git a/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
b/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
index d1de9294..13e54da4 100644
--- a/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
+++ b/src/main/include/log4cxx/rolling/fixedwindowrollingpolicy.h
@@ -102,11 +102,11 @@ class LOG4CXX_EXPORT FixedWindowRollingPolicy : public
RollingPolicyBase
/**
\copybrief RollingPolicyBase::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- MinIndex | 1-12 | 1
- MaxIndex | 1-12 | 7
- ThrowIOExceptionOnForkFailure | True,False | True
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ MinIndex | 1-12 | 1 |
+ MaxIndex | 1-12 | 7 |
+ ThrowIOExceptionOnForkFailure | True,False | True |
\sa RollingPolicyBase::setOption()
*/
diff --git a/src/main/include/log4cxx/rolling/manualtriggeringpolicy.h
b/src/main/include/log4cxx/rolling/manualtriggeringpolicy.h
index 94962fc0..abdffdf0 100644
--- a/src/main/include/log4cxx/rolling/manualtriggeringpolicy.h
+++ b/src/main/include/log4cxx/rolling/manualtriggeringpolicy.h
@@ -77,9 +77,9 @@ class LOG4CXX_EXPORT ManualTriggeringPolicy : public
TriggeringPolicy
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- - | - | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ - | - | - |
*/
void setOption(const LogString& option, const LogString& value)
override;
};
diff --git a/src/main/include/log4cxx/rolling/rollingfileappender.h
b/src/main/include/log4cxx/rolling/rollingfileappender.h
index 276cf6e4..e34916a3 100644
--- a/src/main/include/log4cxx/rolling/rollingfileappender.h
+++ b/src/main/include/log4cxx/rolling/rollingfileappender.h
@@ -128,11 +128,11 @@ class LOG4CXX_EXPORT RollingFileAppender : public
FileAppender
/**
\copybrief FileAppender::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- FileDatePattern | (\ref dateChars "1") | -
- MaxBackupIndex | 1-12 | 0
- MaxFileSize | (\ref fileSz "2") | 10 MB
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ FileDatePattern | (\ref dateChars "1") | - |
+ MaxBackupIndex | 1-12 | 0 |
+ MaxFileSize | (\ref fileSz "2") | 10 MB |
\anchor dateChars (1) A pattern compatible with
java.text.SimpleDateFormat, "ABSOLUTE", "DATE" or "ISO8601".
diff --git a/src/main/include/log4cxx/rolling/rollingpolicybase.h
b/src/main/include/log4cxx/rolling/rollingpolicybase.h
index 61732167..9399286f 100644
--- a/src/main/include/log4cxx/rolling/rollingpolicybase.h
+++ b/src/main/include/log4cxx/rolling/rollingpolicybase.h
@@ -75,10 +75,10 @@ class LOG4CXX_EXPORT RollingPolicyBase :
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- :-------------- | :----------------: | :---------------:
- FileNamePattern | (\ref legalChars "^") | -
- CreateIntermediateDirectories | True,False | False
+ Supported options | Supported values | Default value |
+ :-------------- | :----------------: | :---------------: |
+ FileNamePattern | (\ref legalChars "^") | - |
+ CreateIntermediateDirectories | True,False | False |
\anchor legalChars (^) Legal file name characters plus any
conversion specifier supported by the concrete class.
diff --git a/src/main/include/log4cxx/rolling/sizebasedtriggeringpolicy.h
b/src/main/include/log4cxx/rolling/sizebasedtriggeringpolicy.h
index 63da2701..f26effc5 100644
--- a/src/main/include/log4cxx/rolling/sizebasedtriggeringpolicy.h
+++ b/src/main/include/log4cxx/rolling/sizebasedtriggeringpolicy.h
@@ -84,9 +84,9 @@ class LOG4CXX_EXPORT SizeBasedTriggeringPolicy : public
TriggeringPolicy
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- MaxFileSize | (\ref fileSize "1") | 10 MB
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ MaxFileSize | (\ref fileSize "1") | 10 MB |
\anchor fileSize (1) An integer in the range 0 - 2^63.
You can specify the value with the suffixes "KB", "MB" or "GB"
so that the integer is
diff --git a/src/main/include/log4cxx/spi/filter.h
b/src/main/include/log4cxx/spi/filter.h
index d1043669..04163a18 100644
--- a/src/main/include/log4cxx/spi/filter.h
+++ b/src/main/include/log4cxx/spi/filter.h
@@ -112,9 +112,9 @@ class LOG4CXX_EXPORT Filter : public virtual OptionHandler
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- - | - | -
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ - | - | - |
*/
void setOption(const LogString& option, const LogString& value)
override;
diff --git a/src/main/include/log4cxx/writerappender.h
b/src/main/include/log4cxx/writerappender.h
index 2650cfcc..c4645096 100644
--- a/src/main/include/log4cxx/writerappender.h
+++ b/src/main/include/log4cxx/writerappender.h
@@ -145,9 +145,9 @@ class LOG4CXX_EXPORT WriterAppender : public
AppenderSkeleton
/**
\copybrief AppenderSkeleton::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Encoding |
C,UTF-8,UTF-16,UTF-16BE,UTF-16LE,646,US-ASCII,ISO646-US,ANSI_X3.4-1968,ISO-8859-1,ISO-LATIN-1
| UTF-8
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Encoding |
C,UTF-8,UTF-16,UTF-16BE,UTF-16LE,646,US-ASCII,ISO646-US,ANSI_X3.4-1968,ISO-8859-1,ISO-LATIN-1
| UTF-8 |
\sa AppenderSkeleton::setOption()
*/
diff --git a/src/main/include/log4cxx/xml/xmllayout.h
b/src/main/include/log4cxx/xml/xmllayout.h
index 93089108..40484941 100644
--- a/src/main/include/log4cxx/xml/xmllayout.h
+++ b/src/main/include/log4cxx/xml/xmllayout.h
@@ -107,10 +107,10 @@ class LOG4CXX_EXPORT XMLLayout : public Layout
/**
\copybrief spi::OptionHandler::setOption()
- Supported options | Supported values | Default value
- -------------- | ---------------- | ---------------
- Properties | True,False | False
- LocationInfo | True,False | False
+ Supported options | Supported values | Default value |
+ -------------- | ---------------- | --------------- |
+ Properties | True,False | False |
+ LocationInfo | True,False | False |
*/
void setOption(const LogString& option,
const LogString& value) override;
