nicko 2004/05/30 11:01:19
Modified: src/Appender EventLogAppender.cs FileAppender.cs
NetSendAppender.cs RemotingAppender.cs
RollingFileAppender.cs
Log:
Updated doc comments
Revision Changes Path
1.6 +13 -0 logging-log4net/src/Appender/EventLogAppender.cs
Index: EventLogAppender.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/EventLogAppender.cs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- EventLogAppender.cs 21 May 2004 22:15:32 -0000 1.5
+++ EventLogAppender.cs 30 May 2004 18:01:18 -0000 1.6
@@ -147,6 +147,19 @@
/// <summary>
/// Initialize the appender based on 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>
+ /// </remarks>
override public void ActivateOptions()
{
base.ActivateOptions();
1.4 +17 -2 logging-log4net/src/Appender/FileAppender.cs
Index: FileAppender.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/FileAppender.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- FileAppender.cs 23 Feb 2004 03:18:02 -0000 1.3
+++ FileAppender.cs 30 May 2004 18:01:18 -0000 1.4
@@ -133,9 +133,24 @@
#region Override implementation of AppenderSkeleton
/// <summary>
- /// Activate the options on the file appender. This will
- /// case the file to be opened.
+ /// Activate the options on the file appender.
/// </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>
+ /// This will cause the file to be opened.
+ /// </para>
+ /// </remarks>
override public void ActivateOptions()
{
base.ActivateOptions();
1.5 +11 -0 logging-log4net/src/Appender/NetSendAppender.cs
Index: NetSendAppender.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/NetSendAppender.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NetSendAppender.cs 21 May 2004 22:15:32 -0000 1.4
+++ NetSendAppender.cs 30 May 2004 18:01:18 -0000 1.5
@@ -236,6 +236,17 @@
/// </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>
/// The appender will be ignored if no <see cref="Recipient" />
was specified.
/// </para>
/// </remarks>
1.5 +13 -0 logging-log4net/src/Appender/RemotingAppender.cs
Index: RemotingAppender.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/RemotingAppender.cs,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- RemotingAppender.cs 21 May 2004 22:15:32 -0000 1.4
+++ RemotingAppender.cs 30 May 2004 18:01:18 -0000 1.5
@@ -117,6 +117,19 @@
/// <summary>
/// Initialize the appender based on 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>
+ /// </remarks>
override public void ActivateOptions()
{
base.ActivateOptions();
1.6 +17 -1 logging-log4net/src/Appender/RollingFileAppender.cs
Index: RollingFileAppender.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/RollingFileAppender.cs,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RollingFileAppender.cs 27 Feb 2004 13:03:38 -0000 1.5
+++ RollingFileAppender.cs 30 May 2004 18:01:18 -0000 1.6
@@ -734,10 +734,26 @@
}
/// <summary>
+ /// Initialize the appender based on 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>
/// Sets initial conditions including date/time roll over
information, first check,
/// scheduledFilename, and calls <see cref="ExistingInit"/> to
initialize
/// the current number of backups.
- /// </summary>
+ /// </para>
+ /// </remarks>
override public void ActivateOptions()
{
if (m_rollDate && m_datePattern != null)
