nicko 2004/05/30 10:53:54
Modified: src/Appender AppenderSkeleton.cs
Log:
Renamed LoggingEvent.GetExceptionStrRep to GetExceptionString. Updated doc
comments.
Revision Changes Path
1.4 +26 -1 logging-log4net/src/Appender/AppenderSkeleton.cs
Index: AppenderSkeleton.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/AppenderSkeleton.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AppenderSkeleton.cs 23 Feb 2004 03:18:02 -0000 1.3
+++ AppenderSkeleton.cs 30 May 2004 17:53:54 -0000 1.4
@@ -65,6 +65,12 @@
/// Finalizes this appender by calling the implementation's
/// <see cref="AppenderSkeleton.Close"/> method.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// If this appender has not been closed then the
<c>Finalize</c> method
+ /// will call <see cref="AppenderSkeleton.Close"/>.
+ /// </para>
+ /// </remarks>
~AppenderSkeleton()
{
// An appender might be closed then garbage collected.
@@ -172,6 +178,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>
virtual public void ActivateOptions()
{
}
@@ -338,6 +357,7 @@
/// <summary>
/// Adds a filter to the end of the filter chain.
/// </summary>
+ /// <param name="filter">the filter to add to this
appender</param>
/// <remarks>
/// <para>
/// The Filters are organized in a linked list.
@@ -368,6 +388,11 @@
/// <summary>
/// Clears the filter list for this appender.
/// </summary>
+ /// <remarks>
+ /// <para>
+ /// Clears the filter list for this appender.
+ /// </para>
+ /// </remarks>
virtual public void ClearFilters()
{
m_headFilter = m_tailFilter = null;
@@ -533,7 +558,7 @@
if (m_layout.IgnoresException)
{
- string exceptionStr =
loggingEvent.GetExceptionStrRep();
+ string exceptionStr =
loggingEvent.GetExceptionString();
if (exceptionStr != null && exceptionStr.Length
> 0)
{
// render the event and the exception
