nicko 2004/05/30 03:48:26
Modified: src/Util/PatternStringConverters DatePatternConverter.cs
NewLinePatternConverter.cs
src/Util PatternString.cs
Log:
Updated doc comments
Revision Changes Path
1.4 +16 -0
logging-log4net/src/Util/PatternStringConverters/DatePatternConverter.cs
Index: DatePatternConverter.cs
===================================================================
RCS file:
/home/cvs/logging-log4net/src/Util/PatternStringConverters/DatePatternConverter.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DatePatternConverter.cs 23 Feb 2004 03:18:05 -0000 1.3
+++ DatePatternConverter.cs 30 May 2004 10:48:26 -0000 1.4
@@ -36,6 +36,22 @@
#region Implementation of IOptionHandler
+ /// <summary>
+ /// Initialize the converter options
+ /// </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>
public void ActivateOptions()
{
string dateFormatStr = Option;
1.3 +16 -0
logging-log4net/src/Util/PatternStringConverters/NewLinePatternConverter.cs
Index: NewLinePatternConverter.cs
===================================================================
RCS file:
/home/cvs/logging-log4net/src/Util/PatternStringConverters/NewLinePatternConverter.cs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NewLinePatternConverter.cs 16 Feb 2004 02:10:55 -0000 1.2
+++ NewLinePatternConverter.cs 30 May 2004 10:48:26 -0000 1.3
@@ -33,6 +33,22 @@
{
#region Implementation of IOptionHandler
+ /// <summary>
+ /// Initialize the converter options
+ /// </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>
public void ActivateOptions()
{
if (string.Compare(Option, "DOS", true,
System.Globalization.CultureInfo.InvariantCulture) == 0)
1.4 +14 -1 logging-log4net/src/Util/PatternString.cs
Index: PatternString.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Util/PatternString.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PatternString.cs 23 Feb 2004 03:18:04 -0000 1.3
+++ PatternString.cs 30 May 2004 10:48:26 -0000 1.4
@@ -147,8 +147,21 @@
#region Implementation of IOptionHandler
/// <summary>
- /// Does not do anything as options become effective
immediately.
+ /// Initialize component options
/// </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>
virtual public void ActivateOptions()
{
// nothing to do.
