Skip to content

Commit 6ba82e3

Browse files
Fixed doc issues.
1 parent 953baaa commit 6ba82e3

File tree

8 files changed

+32
-37
lines changed

8 files changed

+32
-37
lines changed

source/LinkedList/ILinkedList.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,43 @@ namespace Open.Collections
44
{
55
public interface ILinkedList<T> : ICollection<T>
66
{
7-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
7+
/// <inheritdoc cref="LinkedList&lt;T&gt;.First"/>
88
LinkedListNode<T> First { get; }
99

10-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
10+
/// <inheritdoc cref="LinkedList&lt;T&gt;.Last"/>
1111
LinkedListNode<T> Last { get; }
1212

13-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
13+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddAfter(LinkedListNode{T}, T)"/>
1414
LinkedListNode<T> AddAfter(LinkedListNode<T> node, T item);
1515

16-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
16+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddAfter(LinkedListNode{T}, LinkedListNode{T})"/>
1717
void AddAfter(LinkedListNode<T> node, LinkedListNode<T> newNode);
1818

19-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
19+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddBefore(LinkedListNode{T}, T)"/>
2020
LinkedListNode<T> AddBefore(LinkedListNode<T> node, T item);
2121

22-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
22+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddBefore(LinkedListNode{T}, LinkedListNode{T})"/>
2323
void AddBefore(LinkedListNode<T> node, LinkedListNode<T> newNode);
2424

25-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
25+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddFirst(T)"/>
2626
LinkedListNode<T> AddFirst(T item);
2727

28-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
28+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddFirst(LinkedListNode{T})"/>
2929
void AddFirst(LinkedListNode<T> newNode);
3030

31-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
31+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddLast(T)"/>
3232
LinkedListNode<T> AddLast(T item);
3333

34-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
34+
/// <inheritdoc cref="LinkedList&lt;T&gt;.AddLast(LinkedListNode{T})"/>
3535
void AddLast(LinkedListNode<T> newNode);
3636

37-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
37+
/// <inheritdoc cref="LinkedList&lt;T&gt;.Remove(LinkedListNode{T})"/>
3838
void Remove(LinkedListNode<T> node);
3939

40-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
40+
/// <inheritdoc cref="LinkedList&lt;T&gt;.RemoveFirst()"/>
4141
void RemoveFirst();
4242

43-
/// <inheritdoc cref="LinkedList&lt;T&gt;"/>
43+
/// <inheritdoc cref="LinkedList&lt;T&gt;.RemoveLast()"/>
4444
void RemoveLast();
4545

4646
/// <summary>

source/Open.Collections.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<PackageProjectUrl>https://github.com/Open-NET-Libraries/Open.Collections/</PackageProjectUrl>
1818
<RepositoryUrl>https://github.com/Open-NET-Libraries/Open.Collections/</RepositoryUrl>
1919
<RepositoryType>git</RepositoryType>
20-
<Version>2.12.4</Version>
20+
<Version>2.12.5</Version>
2121
<PackageReleaseNotes></PackageReleaseNotes>
2222
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2323
<PublishRepositoryUrl>true</PublishRepositoryUrl>

source/Queue/IQueue.cs

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,19 @@
22
{
33
public interface IQueue<T>
44
{
5-
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;"/>
5+
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;.Enqueue(T)"/>
66
void Enqueue(T item);
77

8-
/// <inheritdoc cref="System.Collections.Concurrent.ConcurrentQueue&lt;T&gt;"/>
9-
/// <returns>True if an element was removed and returned from the beginning of the queue successfully; otherwise, false.</returns>
8+
/// <inheritdoc cref="System.Collections.Concurrent.ConcurrentQueue&lt;T&gt;.TryDequeue(out T)"/>
109
bool TryDequeue(out T item);
1110

12-
/// <inheritdoc cref="System.Collections.Concurrent.ConcurrentQueue&lt;T&gt;"/>
13-
/// <summary>
14-
/// Tries to return an object from the beginning of the queue without removing it.
15-
/// </summary>
16-
/// <param name="item">When this method returns, result contains an object from the beginning of the queue or an unspecified value if the operation failed.</param>
11+
/// <inheritdoc cref="System.Collections.Concurrent.ConcurrentQueue&lt;T&gt;.TryPeek(out T)"/>
1712
bool TryPeek(out T item);
1813

19-
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;"/>
14+
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;.Count"/>
2015
int Count { get; }
2116

22-
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;"/>
17+
/// <inheritdoc cref="System.Collections.Generic.Queue&lt;T&gt;.Clear()"/>
2318
void Clear();
2419
}
2520
}

source/ReadOnlyCollectionWrapper.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ protected ReadOnlyCollectionWrapper(TCollection source)
1616
}
1717

1818
#region Implementation of IReadOnlyCollection<T>
19-
/// <inheritdoc cref="ICollection&lt;T&gt;" />
19+
/// <inheritdoc cref="ICollection&lt;T&gt;.Contains(T)" />
2020
public virtual bool Contains(T item)
2121
=> InternalSource.Contains(item);
2222

2323
/// <inheritdoc />
2424
public virtual int Count
2525
=> InternalSource.Count;
2626

27-
/// <inheritdoc cref="ICollection&lt;T&gt;" />
27+
/// <inheritdoc cref="ICollection&lt;T&gt;.IsReadOnly" />
2828
public virtual bool IsReadOnly
2929
=> true;
3030

@@ -39,16 +39,16 @@ public IEnumerator<T> GetEnumerator()
3939
IEnumerator IEnumerable.GetEnumerator()
4040
=> GetEnumerator();
4141

42-
/// <inheritdoc cref="ICollection&lt;T&gt;" />
42+
/// <inheritdoc cref="ICollection&lt;T&gt;.CopyTo(T[], int)" />
4343
public virtual void CopyTo(T[] array, int arrayIndex)
4444
=> InternalSource.CopyTo(array, arrayIndex);
4545
#endregion
4646

47-
/// <inheritdoc cref="ReadOnlyCollectionWrapper{T, TCollection}.CopyTo(Span{T})"/>
47+
/// <inheritdoc cref="Extensions.CopyToSpan{T}(IEnumerable{T}, Span{T})"/>
4848
public virtual Span<T> CopyTo(Span<T> span)
4949
=> InternalSource.CopyToSpan(span);
5050

51-
/// <inheritdoc cref="ISynchronizedCollection&lt;T&gt;" />
51+
/// <inheritdoc cref="ISynchronizedCollection&lt;T&gt;.Export(ICollection{T})" />
5252
public virtual void Export(ICollection<T> to)
5353
=> to.Add(InternalSource);
5454

source/Subsets.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ internal static IEnumerable<int[]> IndexesInternal(int sourceLength, int subsetL
4444
goto loop;
4545
}
4646

47-
/// <inheritdoc cref="Indexes(int, int)"/>
4847
/// <param name="buffer">
4948
/// A buffer to use instead of returning new arrays for each iteration.
5049
/// It must be at least the length of the count.
5150
/// </param>
51+
/// <inheritdoc cref="Indexes(int, int)"/>
5252
public static IEnumerable<int[]> Indexes(int sourceLength, int subsetLength, int[] buffer)
5353
{
5454

source/Synchronized/LockSynchronizedCollectionWrapper.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public override void Clear()
5656
lock (Sync) InternalSource.Clear();
5757
}
5858

59-
/// <inheritdoc cref="CollectionWrapper&lt;T, TCollection&gt;" />
59+
/// <inheritdoc />
6060
public override bool Contains(T item)
6161
{
6262
lock (Sync) return InternalSource.Contains(item);

source/Synchronized/ReadWriteSynchronizedCollectionWrapper.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public override void Add(T[] items)
4747
public override void Clear()
4848
=> Sync.Write(() => InternalSource.Clear());
4949

50-
/// <inheritdoc cref="CollectionWrapper&lt;T, TCollection&gt;" />
50+
/// <inheritdoc />
5151
public override bool Contains(T item)
5252
=> Sync.ReadValue(() => InternalSource.Contains(item));
5353

@@ -61,7 +61,7 @@ public override bool Remove(T item)
6161
return result;
6262
}
6363

64-
/// <inheritdoc cref="CollectionWrapper&lt;T, TCollection&gt;" />
64+
/// <inheritdoc />
6565
public override int Count
6666
=> Sync.ReadValue(() => InternalSource.Count);
6767

@@ -70,15 +70,15 @@ public override int Count
7070
public T[] Snapshot()
7171
=> Sync.ReadValue(() => InternalSource.ToArray());
7272

73-
/// <inheritdoc cref="CollectionWrapper&lt;T, TCollection&gt;" />
73+
/// <inheritdoc />
7474
public override void Export(ICollection<T> to)
7575
=> Sync.Read(() => to.Add(InternalSource));
7676

7777
/// <inheritdoc />
7878
public override void CopyTo(T[] array, int arrayIndex)
7979
=> Sync.Read(() => InternalSource.CopyTo(array, arrayIndex));
8080

81-
/// <inheritdoc cref="ReadOnlyCollectionWrapper{T, TCollection}.CopyTo(Span{T})"/>
81+
/// <inheritdoc />
8282
public override Span<T> CopyTo(Span<T> span)
8383
{
8484
using var read = Sync.ReadLock();

testing/Open.Collections.Tests/Open.Collections.Tests.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
10+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
1111
<PackageReference Include="xunit" Version="2.4.1" />
1212
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
1313
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1414
<PrivateAssets>all</PrivateAssets>
1515
</PackageReference>
16-
<PackageReference Include="coverlet.collector" Version="3.0.3">
16+
<PackageReference Include="coverlet.collector" Version="3.1.0">
1717
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1818
<PrivateAssets>all</PrivateAssets>
1919
</PackageReference>

0 commit comments

Comments
 (0)