nicko 2004/05/30 04:03:26
Modified: src/Appender AppenderCollection.cs
src/Plugin PluginCollection.cs
src/Core LevelCollection.cs
Log:
Fixed arguments to ArgumentOutOfRangeException.
Excluded nested classes from documentation.
Revision Changes Path
1.4 +16 -9 logging-log4net/src/Appender/AppenderCollection.cs
Index: AppenderCollection.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Appender/AppenderCollection.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AppenderCollection.cs 23 Feb 2004 03:18:02 -0000 1.3
+++ AppenderCollection.cs 30 May 2004 11:03:25 -0000 1.4
@@ -34,6 +34,7 @@
/// <summary>
/// Supports type-safe iteration over a <see
cref="AppenderCollection"/>.
/// </summary>
+ /// <exclude/>
public interface IAppenderCollectionEnumerator
{
/// <summary>
@@ -76,9 +77,9 @@
#region Static Wrappers
/// <summary>
- /// Creates a synchronized (thread-safe) wrapper for a
- /// <c>AppenderCollection</c> instance.
+ /// Creates a synchronized (thread-safe) wrapper for a
<c>AppenderCollection</c> instance.
/// </summary>
+ /// <param name="list">list to create a synchronized wrapper
arround</param>
/// <returns>
/// An <c>AppenderCollection</c> wrapper that is synchronized
(thread-safe).
/// </returns>
@@ -90,9 +91,9 @@
}
/// <summary>
- /// Creates a read-only wrapper for a
- /// <c>AppenderCollection</c> instance.
+ /// Creates a read-only wrapper for a <c>AppenderCollection</c>
instance.
/// </summary>
+ /// <param name="list">list to create a readonly wrapper
arround</param>
/// <returns>
/// An <c>AppenderCollection</c> wrapper that is read-only.
/// </returns>
@@ -172,6 +173,7 @@
/// Type visible only to our subclasses
/// Used to access protected constructor
/// </summary>
+ /// <exclude/>
protected enum Tag
{
/// <summary>
@@ -184,6 +186,7 @@
/// Allow subclasses to avoid our default constructors
/// </summary>
/// <param name="t"></param>
+ /// <exclude/>
protected AppenderCollection(Tag t)
{
m_array = null;
@@ -299,6 +302,7 @@
/// <summary>
/// Creates a shallow copy of the <see
cref="AppenderCollection"/>.
/// </summary>
+ /// <returns>A new <see cref="AppenderCollection"/> with a
shallow copy of the collection data.</returns>
public virtual object Clone()
{
AppenderCollection newCol = new
AppenderCollection(m_count);
@@ -448,7 +452,7 @@
/// Returns an enumerator that can iterate through the
<c>AppenderCollection</c>.
/// </summary>
/// <returns>An <see cref="Enumerator"/> for the entire
<c>AppenderCollection</c>.</returns>
- public virtual Enumerator GetEnumerator()
+ public virtual IAppenderCollectionEnumerator GetEnumerator()
{
return new Enumerator(this);
}
@@ -578,7 +582,7 @@
int max = (allowEqualEnd) ? (m_count) : (m_count-1);
if (i < 0 || i > max)
{
- throw new
System.ArgumentOutOfRangeException("Index was out of range. Must be
non-negative and less than the size of the collection. [" + (object)i + "]
Specified argument was out of the range of valid values.");
+ throw new
System.ArgumentOutOfRangeException("i", (object)i, "Index was out of range.
Must be non-negative and less than the size of the collection. [" + (object)i +
"] Specified argument was out of the range of valid values.");
}
}
@@ -657,7 +661,8 @@
/// <summary>
/// Supports simple iteration over a <see
cref="AppenderCollection"/>.
/// </summary>
- public class Enumerator : IEnumerator,
IAppenderCollectionEnumerator
+ /// <exclude/>
+ private class Enumerator : IEnumerator,
IAppenderCollectionEnumerator
{
#region Implementation (data)
@@ -736,6 +741,7 @@
#region Nested Synchronized Wrapper class
+ /// <exclude/>
private class SyncAppenderCollection : AppenderCollection
{
#region Implementation (data)
@@ -880,7 +886,7 @@
#region Type-safe IEnumerable
- public override Enumerator GetEnumerator()
+ public override IAppenderCollectionEnumerator
GetEnumerator()
{
lock(m_root)
{
@@ -933,6 +939,7 @@
#region Nested Read Only Wrapper class
+ /// <exclude/>
private class ReadOnlyAppenderCollection : AppenderCollection
{
#region Implementation (data)
@@ -1036,7 +1043,7 @@
#region Type-safe IEnumerable
- public override Enumerator GetEnumerator()
+ public override IAppenderCollectionEnumerator
GetEnumerator()
{
return m_collection.GetEnumerator();
}
1.4 +12 -5 logging-log4net/src/Plugin/PluginCollection.cs
Index: PluginCollection.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Plugin/PluginCollection.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PluginCollection.cs 23 Feb 2004 03:18:04 -0000 1.3
+++ PluginCollection.cs 30 May 2004 11:03:25 -0000 1.4
@@ -35,6 +35,7 @@
/// <summary>
/// Supports type-safe iteration over a <see
cref="PluginCollection"/>.
/// </summary>
+ /// <exclude/>
public interface IPluginCollectionEnumerator
{
/// <summary>
@@ -80,9 +81,9 @@
#region Static Wrappers
/// <summary>
- /// Creates a synchronized (thread-safe) wrapper for a
- /// <c>PluginCollection</c> instance.
+ /// Creates a synchronized (thread-safe) wrapper for a
<c>PluginCollection</c> instance.
/// </summary>
+ /// <param name="list">list to create a synchronized wrapper
arround</param>
/// <returns>
/// A <c>PluginCollection</c> wrapper that is synchronized
(thread-safe).
/// </returns>
@@ -94,9 +95,9 @@
}
/// <summary>
- /// Creates a read-only wrapper for a
- /// <c>PluginCollection</c> instance.
+ /// Creates a read-only wrapper for a
<c>PluginCollection</c> instance.
/// </summary>
+ /// <param name="list">list to create a readonly wrapper
arround</param>
/// <returns>
/// A <c>PluginCollection</c> wrapper that is read-only.
/// </returns>
@@ -167,6 +168,7 @@
/// Type visible only to our subclasses
/// Used to access protected constructor
/// </summary>
+ /// <exclude/>
protected enum Tag
{
/// <summary>
@@ -179,6 +181,7 @@
/// Allow subclasses to avoid our default constructors
/// </summary>
/// <param name="t"></param>
+ /// <exclude/>
protected PluginCollection(Tag t)
{
m_array = null;
@@ -302,6 +305,7 @@
/// <summary>
/// Creates a shallow copy of the <see
cref="PluginCollection"/>.
/// </summary>
+ /// <returns>A new <see cref="PluginCollection"/> with a
shallow copy of the collection data.</returns>
public virtual object Clone()
{
PluginCollection newCol = new PluginCollection(m_count);
@@ -583,7 +587,7 @@
int max = (allowEqualEnd) ? (m_count) : (m_count-1);
if (i < 0 || i > max)
{
- throw new
System.ArgumentOutOfRangeException("Index was out of range. Must be
non-negative and less than the size of the collection. [" + (object)i + "]
Specified argument was out of the range of valid values.");
+ throw new
System.ArgumentOutOfRangeException("i", (object)i, "Index was out of range.
Must be non-negative and less than the size of the collection. [" + (object)i +
"] Specified argument was out of the range of valid values.");
}
}
@@ -663,6 +667,7 @@
/// <summary>
/// Supports simple iteration over a <see
cref="PluginCollection"/>.
/// </summary>
+ /// <exclude/>
private class Enumerator : IEnumerator,
IPluginCollectionEnumerator
{
#region Implementation (data)
@@ -745,6 +750,7 @@
#region Nested Synchronized Wrapper class
+ /// <exclude/>
private class SyncPluginCollection : PluginCollection
{
#region Implementation (data)
@@ -945,6 +951,7 @@
#region Nested Read Only Wrapper class
+ /// <exclude/>
private class ReadOnlyPluginCollection : PluginCollection
{
#region Implementation (data)
1.4 +6 -5 logging-log4net/src/Core/LevelCollection.cs
Index: LevelCollection.cs
===================================================================
RCS file: /home/cvs/logging-log4net/src/Core/LevelCollection.cs,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LevelCollection.cs 23 Feb 2004 03:18:03 -0000 1.3
+++ LevelCollection.cs 30 May 2004 11:03:25 -0000 1.4
@@ -76,9 +76,9 @@
#region Static Wrappers
/// <summary>
- /// Creates a synchronized (thread-safe) wrapper for a
- /// <c>LevelCollection</c> instance.
+ /// Creates a synchronized (thread-safe) wrapper for a
<c>LevelCollection</c> instance.
/// </summary>
+ /// <param name="list">list to create a synchronized wrapper
arround</param>
/// <returns>
/// A <c>LevelCollection</c> wrapper that is synchronized
(thread-safe).
/// </returns>
@@ -90,9 +90,9 @@
}
/// <summary>
- /// Creates a read-only wrapper for a
- /// <c>LevelCollection</c> instance.
+ /// Creates a read-only wrapper for a <c>LevelCollection</c>
instance.
/// </summary>
+ /// <param name="list">list to create a readonly wrapper
arround</param>
/// <returns>
/// A <c>LevelCollection</c> wrapper that is read-only.
/// </returns>
@@ -292,6 +292,7 @@
/// <summary>
/// Creates a shallow copy of the <see cref="LevelCollection"/>.
/// </summary>
+ /// <returns>A new <see cref="LevelCollection"/> with a shallow
copy of the collection data.</returns>
public virtual object Clone()
{
LevelCollection newCol = new LevelCollection(m_count);
@@ -572,7 +573,7 @@
int max = (allowEqualEnd) ? (m_count) : (m_count-1);
if (i < 0 || i > max)
{
- throw new
System.ArgumentOutOfRangeException("Index was out of range. Must be
non-negative and less than the size of the collection. [" + (object)i + "]
Specified argument was out of the range of valid values.");
+ throw new
System.ArgumentOutOfRangeException("i", (object)i, "Index was out of range.
Must be non-negative and less than the size of the collection. [" + (object)i +
"] Specified argument was out of the range of valid values.");
}
}
