[logging-log4cxx] branch ghpr_24_mapfilter updated: Example usage.

[ts...@apache.org]

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

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


The following commit(s) were added to refs/heads/ghpr_24_mapfilter by this push:
     new aa05380  Example usage.
aa05380 is described below

commit aa05380e82eff70c26ccf252451861ad403f42f0
Author: Thorsten Schöning <ts...@am-soft.de>
AuthorDate: Sun Jun 7 15:29:42 2020 +0200

    Example usage.
---
 src/main/include/log4cxx/filter/mapfilter.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/main/include/log4cxx/filter/mapfilter.h b/src/main/include/log4cxx/filter/mapfilter.h
index 4f03616..768fbd6 100644
--- a/src/main/include/log4cxx/filter/mapfilter.h
+++ b/src/main/include/log4cxx/filter/mapfilter.h
@@ -30,7 +30,15 @@ namespace filter
 {
 
 /**
- * A Filter that operates on a Map.
+ * A Filter that operates on a Map and can be used like in the following example:
+ * <pre>
+ * &lt;filter class="MapFilter"&gt;
+ *     &lt;param name="user.ip"       value="127.0.0.1" /&gt;
+ *     &lt;param name="user.name"     value="test2"     /&gt;
+ *     &lt;param name="Operator"      value="AND"       /&gt;
+ *     &lt;param name="AcceptOnMatch" value="false"     /&gt;
+ * &lt;/filter&gt;
+ * </pre>
  */
 class LOG4CXX_EXPORT MapFilter: public log4cxx::spi::Filter
 {