nicko 2004/05/30 04:06:12
Modified: src/Core IOptionHandler.cs
Log:
Updated doc comments
Revision Changes Path
1.3 +8 -2 logging-log4net/src/Core/IOptionHandler.cs
Index: IOptionHandler.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Core/IOptionHandler.cs,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- IOptionHandler.cs 16 Feb 2004 02:10:52 -0000 1.2
+++ IOptionHandler.cs 30 May 2004 11:06:12 -0000 1.3
@@ -27,12 +27,18 @@
public interface IOptionHandler
{
/// <summary>
- /// Activate the options that were previously set with calls to
option setters.
+ /// Activate the options that were previously set with calls to
properties.
/// </summary>
/// <remarks>
- /// This allows to defer activation of the options until all
+ /// <para>
+ /// This allows an object to defer activation of its options
until all
/// options have been set. This is required for components
which have
/// related options that remain ambiguous until all are set.
+ /// </para>
+ /// <para>
+ /// If a component implements this interface then this method
must be called
+ /// after its properties have been set before the component can
be used.
+ /// </para>
/// </remarks>
void ActivateOptions();
}