[prev in list] [next in list] [prev in thread] [next in thread] 

List:       log4net-dev
Subject:    cvs commit: logging-log4net/src/Layout SimpleLayout.cs LayoutSkeleton.cs
From:       nicko () apache ! org
Date:       2004-05-30 11:23:01
Message-ID: 20040530112301.96619.qmail () minotaur ! apache ! org
[Download RAW message or body]

nicko       2004/05/30 04:23:01

  Modified:    src/Layout SimpleLayout.cs LayoutSkeleton.cs
  Log:
  Updated doc comments
  
  Revision  Changes    Path
  1.4       +14 -1     logging-log4net/src/Layout/SimpleLayout.cs
  
  Index: SimpleLayout.cs
  ===================================================================
  RCS file: /home/cvs/logging-log4net/src/Layout/SimpleLayout.cs,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- SimpleLayout.cs	23 Feb 2004 03:18:04 -0000	1.3
  +++ SimpleLayout.cs	30 May 2004 11:23:01 -0000	1.4
  @@ -55,8 +55,21 @@
   		#region Implementation of IOptionHandler
   
   		/// <summary>
  -		/// Does not do anything as options become effective immediately.
  +		/// Initialize layout 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>
   		override public void ActivateOptions() 
   		{
   			// nothing to do.
  
  
  
  1.3       +15 -6     logging-log4net/src/Layout/LayoutSkeleton.cs
  
  Index: LayoutSkeleton.cs
  ===================================================================
  RCS file: /home/cvs/logging-log4net/src/Layout/LayoutSkeleton.cs,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- LayoutSkeleton.cs	16 Feb 2004 02:10:53 -0000	1.2
  +++ LayoutSkeleton.cs	30 May 2004 11:23:01 -0000	1.3
  @@ -75,11 +75,20 @@
   		/// Activate the options that were previously set with calls to option setters.
   		/// </summary>
   		/// <remarks>
  -		/// <para>This allows deferred activation of the options once all
  -		/// options have been set. This is required for components which have
  -		/// related options that remain ambiguous until all are set.</para>
  -		/// 
  - 		/// <para>This method must be implemented by the subclass.</para>
  +		/// <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 method must be implemented by the subclass.
  + 		/// </para>
   		/// </remarks>
   		abstract public void ActivateOptions();
   
  @@ -161,7 +170,7 @@
   		}
   
   		/// <summary>
  -		/// Flag indicating if this layout handle exceptions
  +		/// Flag indicating if this layout handles exceptions
   		/// </summary>
   		/// <value><c>false</c> if this layout handles exceptions</value>
   		/// <remarks>
  
  
  
[prev in list] [next in list] [prev in thread] [next in thread]