Skip to content

Commit 5490fdb

Browse files
committed
Corrected XmlDoc on InsertItem
Updated XmlDoc documentation for `InsertItem` to correctly describe the method, parameters, exceptions, and purpose (via remarks). The previous version inadvertently included the summary from a different method.
1 parent 13f83ec commit 5490fdb

7 files changed

Lines changed: 22 additions & 16 deletions

File tree

Ignia.Topics.Data.Caching/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
[assembly: AssemblyTrademark("")]
2222
[assembly: AssemblyCulture("")]
2323
[assembly: ComVisible(false)]
24-
[assembly: AssemblyVersion("3.5.1749.0")]
25-
[assembly: AssemblyFileVersion("3.5.1781.0")]
24+
[assembly: AssemblyVersion("3.5.1751.0")]
25+
[assembly: AssemblyFileVersion("3.5.1783.0")]
2626
[assembly: CLSCompliant(true)]
2727
[assembly: Guid("206b7f91-ca25-4e9d-9576-60d2e54a2c0a")]
2828

Ignia.Topics.Tests/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
[assembly: AssemblyTrademark("")]
2222
[assembly: AssemblyCulture("")]
2323
[assembly: ComVisible(false)]
24-
[assembly: AssemblyVersion("3.5.1769.0")]
25-
[assembly: AssemblyFileVersion("3.5.1817.0")]
24+
[assembly: AssemblyVersion("3.5.1771.0")]
25+
[assembly: AssemblyFileVersion("3.5.1819.0")]
2626
[assembly: CLSCompliant(true)]
2727
[assembly: Guid("27632801-bfe3-41d9-8678-3c4bbe45e6c9")]

Ignia.Topics.ViewModels/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
[assembly: AssemblyTrademark("")]
2222
[assembly: AssemblyCulture("")]
2323
[assembly: ComVisible(false)]
24-
[assembly: AssemblyVersion("3.5.1750.0")]
25-
[assembly: AssemblyFileVersion("3.5.1781.0")]
24+
[assembly: AssemblyVersion("3.5.1752.0")]
25+
[assembly: AssemblyFileVersion("3.5.1783.0")]
2626
[assembly: CLSCompliant(true)]
2727
[assembly: Guid("e52fc633-b4c5-4a2b-8caf-30e756d7a6a7")]
2828

Ignia.Topics.Web.Mvc/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
[assembly: AssemblyTrademark("")]
2222
[assembly: AssemblyCulture("")]
2323
[assembly: ComVisible(false)]
24-
[assembly: AssemblyVersion("3.5.1754.0")]
25-
[assembly: AssemblyFileVersion("3.5.1786.0")]
24+
[assembly: AssemblyVersion("3.5.1756.0")]
25+
[assembly: AssemblyFileVersion("3.5.1788.0")]
2626
[assembly: CLSCompliant(true)]
2727
[assembly: Guid("3b3ce34d-b5e5-47ca-bfef-e6740650f378")]

Ignia.Topics.Web/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
[assembly: AssemblyTrademark("")]
2222
[assembly: AssemblyCulture("")]
2323
[assembly: ComVisible(false)]
24-
[assembly: AssemblyVersion("3.5.1748.0")]
25-
[assembly: AssemblyFileVersion("3.5.1772.0")]
24+
[assembly: AssemblyVersion("3.5.1750.0")]
25+
[assembly: AssemblyFileVersion("3.5.1774.0")]
2626
[assembly: CLSCompliant(true)]
2727
[assembly: Guid("c98f7b48-a085-4394-b820-c244f23868ce")]

Ignia.Topics/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
[assembly: AssemblyTrademark("")]
2323
[assembly: AssemblyCulture("")]
2424
[assembly: ComVisible(false)]
25-
[assembly: AssemblyVersion("3.5.1749.0")]
26-
[assembly: AssemblyFileVersion("3.5.1781.0")]
25+
[assembly: AssemblyVersion("3.5.1751.0")]
26+
[assembly: AssemblyFileVersion("3.5.1783.0")]
2727
[assembly: InternalsVisibleTo("Ignia.Topics.Tests")]
2828
[assembly: CLSCompliant(true)]
2929
[assembly: GuidAttribute("3CA9F6CB-B45A-4E74-AAA4-0C87CAA2704F")]

Ignia.Topics/Reflection/MemberInfoCollection{T}.cs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,21 @@ internal MemberInfoCollection(Type type, IEnumerable<T> members) : base(StringCo
6464
/*==========================================================================================================================
6565
| OVERRIDE: INSERT ITEM
6666
\-------------------------------------------------------------------------------------------------------------------------*/
67-
/// <summary>
68-
/// Returns the type associated with this collection.
69-
/// </summary>
67+
/// <summary>Fires any time an item is added to the collection.</summary>
68+
/// <remarks>
69+
/// Compared to the base implementation, will throw a specific <see cref="ArgumentException"/> error if a duplicate key is
70+
/// inserted. This conveniently provides the name of the <see cref="Type"/> and the <paramref name="item"/>'s <see
71+
/// cref="MemberInfo.Name"/>, so it's clear what is being duplicated.
72+
/// </remarks>
73+
/// <param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
74+
/// <param name="item">The <see cref="MemberInfo" /> instance to insert.</param>
75+
/// <exception cref="ArgumentException">The Type '{Type.Name}' already contains the MemberInfo '{item.Name}'</exception>
7076
protected override void InsertItem(int index, T item) {
7177
if (!Contains(item.Name)) {
7278
base.InsertItem(index, item);
7379
}
7480
else {
75-
throw new ArgumentException("The Type '" + Type.Name + "' already contains the MemberInfo '" + item.Name + "'");
81+
throw new ArgumentException($"The Type '{Type.Name}' already contains the MemberInfo '{item.Name}'");
7682
}
7783
}
7884

0 commit comments

Comments
 (0)