Author: nicko
Date: Mon Dec 12 11:26:31 2005
New Revision: 356344
URL: http://svn.apache.org/viewcvs?rev=356344&view=rev
Log:
Updated doc comments to refer to conversion pattern names rather than
conversion characters as the patterns can now be words rather than just single
letters.
Modified:
logging/log4net/trunk/src/Layout/PatternLayout.cs
logging/log4net/trunk/src/Util/PatternString.cs
Modified: logging/log4net/trunk/src/Layout/PatternLayout.cs
URL:
http://svn.apache.org/viewcvs/logging/log4net/trunk/src/Layout/PatternLayout.cs?rev=356344&r1=356343&r2=356344&view=diff
==============================================================================
--- logging/log4net/trunk/src/Layout/PatternLayout.cs (original)
+++ logging/log4net/trunk/src/Layout/PatternLayout.cs Mon Dec 12 11:26:31 2005
@@ -19,7 +19,6 @@
using System;
using System.Collections;
using System.IO;
-using System.Text;
using log4net.Core;
using log4net.Layout.Pattern;
@@ -49,7 +48,7 @@
/// <para>
/// Each conversion specifier starts with a percent sign (%) and is
/// followed by optional <i>format modifiers</i> and a <i>conversion
- /// character</i>. The conversion character specifies the type of
+ /// pattern name</i>. The conversion pattern name specifies the type of
/// data, e.g. logger, level, date, thread name. The format
/// modifiers control such things as field width, padding, left and
/// right justification. The following is a simple example.
@@ -78,11 +77,11 @@
/// justified to a width of five characters.
/// </para>
/// <para>
- /// The recognized conversion characters are:
+ /// The recognized conversion pattern names are:
/// </para>
/// <list type="table">
/// <listheader>
- /// <term>Conversion Character</term>
+ /// <term>Conversion Pattern Name</term>
/// <description>Effect</description>
/// </listheader>
/// <item>
@@ -328,7 +327,7 @@
/// characters.
/// </para>
/// <para>
- /// This conversion character offers the same
performance as using
+ /// This conversion pattern offers the same
performance as using
/// non-portable line separator strings such as
"\n", or "\r\n".
/// Thus, it is the preferred way of specifying a
line separator.
/// </para>
@@ -528,7 +527,7 @@
/// </list>
/// <para>
/// The single letter patterns are deprecated in favor of the
- /// longer more descriptive patterns.
+ /// longer more descriptive pattern names.
/// </para>
/// <para>
/// By default the relevant information is output as is. However,
@@ -537,7 +536,7 @@
/// </para>
/// <para>
/// The optional format modifier is placed between the percent sign
- /// and the conversion character.
+ /// and the conversion pattern name.
/// </para>
/// <para>
/// The first optional format modifier is the <i>left justification
Modified: logging/log4net/trunk/src/Util/PatternString.cs
URL:
http://svn.apache.org/viewcvs/logging/log4net/trunk/src/Util/PatternString.cs?rev=356344&r1=356343&r2=356344&view=diff
==============================================================================
--- logging/log4net/trunk/src/Util/PatternString.cs (original)
+++ logging/log4net/trunk/src/Util/PatternString.cs Mon Dec 12 11:26:31 2005
@@ -19,7 +19,6 @@
using System;
using System.Collections;
using System.IO;
-using System.Text;
using log4net.Util;
using log4net.Util.PatternStringConverters;
@@ -43,11 +42,11 @@
/// of the process in general.
/// </para>
/// <para>
- /// The recognized conversion characters are:
+ /// The recognized conversion pattern names are:
/// </para>
/// <list type="table">
/// <listheader>
- /// <term>Conversion Character</term>
+ /// <term>Conversion Pattern Name</term>
/// <description>Effect</description>
/// </listheader>
/// <item>
@@ -121,7 +120,7 @@
/// characters.
/// </para>
/// <para>
- /// This conversion character offers the same
performance as using
+ /// This conversion pattern name offers the same
performance as using
/// non-portable line separator strings such as
"\n", or "\r\n".
/// Thus, it is the preferred way of specifying a
line separator.
/// </para>
@@ -236,7 +235,7 @@
/// </list>
/// <para>
/// Additional pattern converters may be registered with a specific
<see cref="PatternString"/>
- /// instance using <see cref="AddConverter(ConverterInfo)"/> or
+ /// instance using <see
cref="AddConverter(PatternString.ConverterInfo)"/> or
/// <see cref="AddConverter(string, Type)" />.
/// </para>
/// <para>
@@ -388,7 +387,7 @@
/// <para>
/// Returns PatternParser used to parse the conversion string.
Subclasses
/// may override this to return a subclass of PatternParser
which recognize
- /// custom conversion characters.
+ /// custom conversion pattern name.
/// </para>
/// </remarks>
private PatternParser CreatePatternParser(string pattern)
