nicko 2004/05/30 04:04:08
Modified: src/Filter FilterSkeleton.cs MdcFilter.cs NdcFilter.cs
StringMatchFilter.cs
Log:
Updated doc comments
Revision Changes Path
1.4 +18 -2 logging-log4net/src/Filter/FilterSkeleton.cs
Index: FilterSkeleton.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Filter/FilterSkeleton.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- FilterSkeleton.cs 23 Feb 2004 03:18:03 -0000 1.3
+++ FilterSkeleton.cs 30 May 2004 11:04:08 -0000 1.4
@@ -74,9 +74,25 @@
#region Implementation of IOptionHandler
/// <summary>
- /// Usually filters options become active when set.
- /// We provide a default do-nothing implementation for
convenience.
+ /// Initialize the filter with the options set
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// This is part of the <see cref="IOptionHandler"/> delayed
object
+ /// activation scheme. The <see cref="ActivateOptions"/> method
must
+ /// be called on this object after the configuration properties
have
+ /// been set. Until <see cref="ActivateOptions"/> is called this
+ /// object is in an undefined state and must not be used.
+ /// </para>
+ /// <para>
+ /// If any of the configuration properties are modified then
+ /// <see cref="ActivateOptions"/> must be called again.
+ /// </para>
+ /// <para>
+ /// Typically filter's options become active immediatly on set,
+ /// however this method must still be called.
+ /// </para>
+ /// </remarks>
virtual public void ActivateOptions()
{
}
1.4 +13 -0 logging-log4net/src/Filter/MdcFilter.cs
Index: MdcFilter.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Filter/MdcFilter.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MdcFilter.cs 23 Feb 2004 03:18:03 -0000 1.3
+++ MdcFilter.cs 30 May 2004 11:04:08 -0000 1.4
@@ -81,6 +81,19 @@
/// <summary>
/// Initialize and precompile the Regex if required
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// This is part of the <see cref="IOptionHandler"/> delayed
object
+ /// activation scheme. The <see cref="ActivateOptions"/> method
must
+ /// be called on this object after the configuration properties
have
+ /// been set. Until <see cref="ActivateOptions"/> is called this
+ /// object is in an undefined state and must not be used.
+ /// </para>
+ /// <para>
+ /// If any of the configuration properties are modified then
+ /// <see cref="ActivateOptions"/> must be called again.
+ /// </para>
+ /// </remarks>
override public void ActivateOptions()
{
if (m_stringRegexToMatch != null)
1.4 +13 -0 logging-log4net/src/Filter/NdcFilter.cs
Index: NdcFilter.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Filter/NdcFilter.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- NdcFilter.cs 23 Feb 2004 03:18:03 -0000 1.3
+++ NdcFilter.cs 30 May 2004 11:04:08 -0000 1.4
@@ -75,6 +75,19 @@
/// <summary>
/// Initialize and precompile the Regex if required
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// This is part of the <see cref="IOptionHandler"/> delayed
object
+ /// activation scheme. The <see cref="ActivateOptions"/> method
must
+ /// be called on this object after the configuration properties
have
+ /// been set. Until <see cref="ActivateOptions"/> is called this
+ /// object is in an undefined state and must not be used.
+ /// </para>
+ /// <para>
+ /// If any of the configuration properties are modified then
+ /// <see cref="ActivateOptions"/> must be called again.
+ /// </para>
+ /// </remarks>
override public void ActivateOptions()
{
if (m_stringRegexToMatch != null)
1.4 +13 -0 logging-log4net/src/Filter/StringMatchFilter.cs
Index: StringMatchFilter.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Filter/StringMatchFilter.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StringMatchFilter.cs 23 Feb 2004 03:18:03 -0000 1.3
+++ StringMatchFilter.cs 30 May 2004 11:04:08 -0000 1.4
@@ -75,6 +75,19 @@
/// <summary>
/// Initialize and precompile the Regex if required
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// This is part of the <see cref="IOptionHandler"/> delayed
object
+ /// activation scheme. The <see cref="ActivateOptions"/> method
must
+ /// be called on this object after the configuration properties
have
+ /// been set. Until <see cref="ActivateOptions"/> is called this
+ /// object is in an undefined state and must not be used.
+ /// </para>
+ /// <para>
+ /// If any of the configuration properties are modified then
+ /// <see cref="ActivateOptions"/> must be called again.
+ /// </para>
+ /// </remarks>
override public void ActivateOptions()
{
if (m_stringRegexToMatch != null)
