You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4net-dev@logging.apache.org by bo...@apache.org on 2011/08/18 12:37:39 UTC
svn commit: r1159147 - in /logging/log4net/trunk/src:
Appender/AppenderCollection.cs Appender/AppenderSkeleton.cs
Appender/EventLogAppender.cs Appender/NetSendAppender.cs
Core/LevelCollection.cs MDC.cs Plugin/PluginCollection.cs
Util/OptionConverter.cs
Author: bodewig
Date: Thu Aug 18 10:37:39 2011
New Revision: 1159147
URL: http://svn.apache.org/viewvc?rev=1159147&view=rev
Log:
fix some XML doc warnings
Modified:
logging/log4net/trunk/src/Appender/AppenderCollection.cs
logging/log4net/trunk/src/Appender/AppenderSkeleton.cs
logging/log4net/trunk/src/Appender/EventLogAppender.cs
logging/log4net/trunk/src/Appender/NetSendAppender.cs
logging/log4net/trunk/src/Core/LevelCollection.cs
logging/log4net/trunk/src/MDC.cs
logging/log4net/trunk/src/Plugin/PluginCollection.cs
logging/log4net/trunk/src/Util/OptionConverter.cs
Modified: logging/log4net/trunk/src/Appender/AppenderCollection.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Appender/AppenderCollection.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Appender/AppenderCollection.cs (original)
+++ logging/log4net/trunk/src/Appender/AppenderCollection.cs Thu Aug 18 10:37:39 2011
@@ -566,9 +566,9 @@ namespace log4net.Appender
#region Implementation (helpers)
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero</para>
+ /// <para><paramref name="i"/> is less than zero</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="AppenderCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="AppenderCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i)
{
@@ -576,9 +576,9 @@ namespace log4net.Appender
}
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero</para>
+ /// <para><paramref name="i"/> is less than zero</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="AppenderCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="AppenderCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i, bool allowEqualEnd)
{
Modified: logging/log4net/trunk/src/Appender/AppenderSkeleton.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Appender/AppenderSkeleton.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Appender/AppenderSkeleton.cs (original)
+++ logging/log4net/trunk/src/Appender/AppenderSkeleton.cs Thu Aug 18 10:37:39 2011
@@ -362,14 +362,14 @@ namespace log4net.Appender
/// <list type="bullet">
/// <item>
/// <description>
- /// Checks that the severity of the <paramref name="loggingEvent"/>
+ /// Checks that the severity of the <paramref name="loggingEvents"/>
/// is greater than or equal to the <see cref="Threshold"/> of this
/// appender.</description>
/// </item>
/// <item>
/// <description>
/// Checks that the <see cref="IFilter"/> chain accepts the
- /// <paramref name="loggingEvent"/>.
+ /// <paramref name="loggingEvents"/>.
/// </description>
/// </item>
/// <item>
Modified: logging/log4net/trunk/src/Appender/EventLogAppender.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Appender/EventLogAppender.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Appender/EventLogAppender.cs (original)
+++ logging/log4net/trunk/src/Appender/EventLogAppender.cs Thu Aug 18 10:37:39 2011
@@ -403,10 +403,10 @@ namespace log4net.Appender
#region Protected Instance Methods
/// <summary>
- /// Get the equivalent <see cref="EventLogEntryType"/> for a <see cref="Level"/> <paramref name="p"/>
+ /// Get the equivalent <see cref="EventLogEntryType"/> for a <see cref="Level"/> <paramref name="level"/>
/// </summary>
/// <param name="level">the Level to convert to an EventLogEntryType</param>
- /// <returns>The equivalent <see cref="EventLogEntryType"/> for a <see cref="Level"/> <paramref name="p"/></returns>
+ /// <returns>The equivalent <see cref="EventLogEntryType"/> for a <see cref="Level"/> <paramref name="level"/></returns>
/// <remarks>
/// Because there are fewer applicable <see cref="EventLogEntryType"/>
/// values to use in logging levels than there are in the
Modified: logging/log4net/trunk/src/Appender/NetSendAppender.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Appender/NetSendAppender.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Appender/NetSendAppender.cs (original)
+++ logging/log4net/trunk/src/Appender/NetSendAppender.cs Thu Aug 18 10:37:39 2011
@@ -68,10 +68,10 @@ namespace log4net.Appender
/// <term>Send a message to a user account on the local machine</term>
/// <description>
/// <para>
- /// <paramref name="Server"/> = <name of the local machine>
+ /// <see cref="NetSendAppender.Server"/> = <name of the local machine>
/// </para>
/// <para>
- /// <paramref name="Recipient"/> = <user name>
+ /// <see cref="NetSendAppender.Recipient"/> = <user name>
/// </para>
/// </description>
/// </item>
@@ -79,10 +79,10 @@ namespace log4net.Appender
/// <term>Send a message to a user account on a remote machine</term>
/// <description>
/// <para>
- /// <paramref name="Server"/> = <name of the remote machine>
+ /// <see cref="NetSendAppender.Server"/> = <name of the remote machine>
/// </para>
/// <para>
- /// <paramref name="Recipient"/> = <user name>
+ /// <see cref="NetSendAppender.Recipient"/> = <user name>
/// </para>
/// </description>
/// </item>
@@ -90,10 +90,10 @@ namespace log4net.Appender
/// <term>Send a message to a domain user account</term>
/// <description>
/// <para>
- /// <paramref name="Server"/> = <name of a domain controller | uninitialized>
+ /// <see cref="NetSendAppender.Server"/> = <name of a domain controller | uninitialized>
/// </para>
/// <para>
- /// <paramref name="Recipient"/> = <user name>
+ /// <see cref="NetSendAppender.Recipient"/> = <user name>
/// </para>
/// </description>
/// </item>
@@ -101,7 +101,7 @@ namespace log4net.Appender
/// <term>Send a message to all the names in a workgroup or domain</term>
/// <description>
/// <para>
- /// <paramref name="Recipient"/> = <workgroup name | domain name>*
+ /// <see cref="NetSendAppender.Recipient"/> = <workgroup name | domain name>*
/// </para>
/// </description>
/// </item>
@@ -109,10 +109,10 @@ namespace log4net.Appender
/// <term>Send a message from the local machine to a remote machine</term>
/// <description>
/// <para>
- /// <paramref name="Server"/> = <name of the local machine | uninitialized>
+ /// <see cref="NetSendAppender.Server"/> = <name of the local machine | uninitialized>
/// </para>
/// <para>
- /// <paramref name="Recipient"/> = <name of the remote machine>
+ /// <see cref="NetSendAppender.Recipient"/> = <name of the remote machine>
/// </para>
/// </description>
/// </item>
Modified: logging/log4net/trunk/src/Core/LevelCollection.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Core/LevelCollection.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Core/LevelCollection.cs (original)
+++ logging/log4net/trunk/src/Core/LevelCollection.cs Thu Aug 18 10:37:39 2011
@@ -541,9 +541,9 @@ namespace log4net.Core
#region Implementation (helpers)
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero</para>
+ /// <para><paramref name="i"/> is less than zero</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="LevelCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="LevelCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i)
{
@@ -551,9 +551,9 @@ namespace log4net.Core
}
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero</para>
+ /// <para><paramref name="i"/> is less than zero</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="LevelCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="LevelCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i, bool allowEqualEnd)
{
Modified: logging/log4net/trunk/src/MDC.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/MDC.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/MDC.cs (original)
+++ logging/log4net/trunk/src/MDC.cs Thu Aug 18 10:37:39 2011
@@ -107,13 +107,13 @@ namespace log4net
/// </para>
/// </note>
/// <para>
- /// Puts a context value (the <paramref name="val" /> parameter) as identified
+ /// Puts a context value (the <paramref name="value" /> parameter) as identified
/// with the <paramref name="key" /> parameter into the current thread's
/// context map.
/// </para>
/// <para>
/// If a value is already defined for the <paramref name="key" />
- /// specified then the value will be replaced. If the <paramref name="val" />
+ /// specified then the value will be replaced. If the <paramref name="value" />
/// is specified as <c>null</c> then the key value mapping will be removed.
/// </para>
/// </remarks>
Modified: logging/log4net/trunk/src/Plugin/PluginCollection.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Plugin/PluginCollection.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Plugin/PluginCollection.cs (original)
+++ logging/log4net/trunk/src/Plugin/PluginCollection.cs Thu Aug 18 10:37:39 2011
@@ -553,9 +553,9 @@ namespace log4net.Plugin
#region Implementation (helpers)
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero.</para>
+ /// <para><paramref name="i"/> is less than zero.</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="PluginCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="PluginCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i)
{
@@ -563,9 +563,9 @@ namespace log4net.Plugin
}
/// <exception cref="ArgumentOutOfRangeException">
- /// <para><paramref name="index"/> is less than zero.</para>
+ /// <para><paramref name="i"/> is less than zero.</para>
/// <para>-or-</para>
- /// <para><paramref name="index"/> is equal to or greater than <see cref="PluginCollection.Count"/>.</para>
+ /// <para><paramref name="i"/> is equal to or greater than <see cref="PluginCollection.Count"/>.</para>
/// </exception>
private void ValidateIndex(int i, bool allowEqualEnd)
{
Modified: logging/log4net/trunk/src/Util/OptionConverter.cs
URL: http://svn.apache.org/viewvc/logging/log4net/trunk/src/Util/OptionConverter.cs?rev=1159147&r1=1159146&r2=1159147&view=diff
==============================================================================
--- logging/log4net/trunk/src/Util/OptionConverter.cs (original)
+++ logging/log4net/trunk/src/Util/OptionConverter.cs Thu Aug 18 10:37:39 2011
@@ -492,7 +492,7 @@ namespace log4net.Util
}
/// <summary>
- /// Performs variable substitution in string <paramref name="val"/> from the
+ /// Performs variable substitution in string <paramref name="value"/> from the
/// values of keys found in <paramref name="props"/>.
/// </summary>
/// <param name="value">The string on which variable substitution is performed.</param>