Skip to content

Commit 10067ee

Browse files
committed
Add some XML doc comments
1 parent 046ec10 commit 10067ee

4 files changed

Lines changed: 20 additions & 1 deletion

File tree

src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ namespace Lucene.Net.Search.Grouping
3434
/// @lucene.experimental
3535
/// </summary>
3636
/// <typeparam name="TGroupValue"></typeparam>
37-
// ReSharper disable once RedundantExtendsListEntry
3837
public abstract class AbstractAllGroupsCollector<TGroupValue> : IAbstractAllGroupsCollector
3938
{
4039
/// <summary>
@@ -92,6 +91,9 @@ public virtual void SetScorer(Scorer scorer)
9291

9392
#region Explicit interface implementations
9493

94+
/// <summary>
95+
/// LUCENENET specific method to provide an object-based implementation of <see cref="Groups"/>.
96+
/// </summary>
9597
ICollection<object> IAbstractAllGroupsCollector.Groups => new CastingCollectionAdapter<TGroupValue, object>(Groups);
9698

9799
#endregion

src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,14 @@ protected GroupCount(TGroupValue groupValue) // LUCENENET: CA1012: Abstract type
117117

118118
#region Explicit interface implementations
119119

120+
/// <summary>
121+
/// LUCENENET specific method to provide an object-based implementation of <see cref="GroupValue"/>.
122+
/// </summary>
120123
object IGroupCount.GroupValue => GroupValue;
121124

125+
/// <summary>
126+
/// LUCENENET specific method to provide an object-based implementation of <see cref="UniqueValues"/>.
127+
/// </summary>
122128
ISet<object> IGroupCount.UniqueValues => new CastingSetAdapter<TGroupValue, object>(UniqueValues);
123129

124130
#endregion

src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,12 @@ public virtual void SetNextReader(AtomicReaderContext context)
423423

424424
#region Explicit interface implementations
425425

426+
/// <summary>
427+
/// LUCENENET specific method to provide an <see cref="ISearchGroup"/>-based implementation of <see cref="GetTopGroups(int, bool)"/>.
428+
/// </summary>
429+
/// <param name="groupOffset">The offset in the collected groups</param>
430+
/// <param name="fillFields">Whether to fill to <see cref="ISearchGroup.SortValues"/></param>
431+
/// <returns>top groups, starting from offset</returns>
426432
ICollection<ISearchGroup> IAbstractFirstPassGroupingCollector.GetTopGroups(int groupOffset, bool fillFields)
427433
{
428434
var topGroups = GetTopGroups(groupOffset, fillFields);

src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,11 @@ public virtual TopGroups<TGroupValue> GetTopGroups(int withinGroupOffset)
148148

149149
#region Explicit interface implementations
150150

151+
/// <summary>
152+
/// LUCENENET specific method to provide an <see cref="ITopGroups"/>-based implementation of <see cref="GetTopGroups(int)"/>.
153+
/// </summary>
154+
/// <param name="withinGroupOffset">The offset within each group</param>
155+
/// <returns>The top groups</returns>
151156
ITopGroups IAbstractSecondPassGroupingCollector.GetTopGroups(int withinGroupOffset)
152157
=> GetTopGroups(withinGroupOffset);
153158

0 commit comments

Comments
 (0)