You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/02/05 16:51:40 UTC
[05/27] lucenenet git commit: Lucene.Net.Grouping: fix documentation
comment formatting problems
Lucene.Net.Grouping: fix documentation comment formatting problems
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/1b9fe40d
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/1b9fe40d
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/1b9fe40d
Branch: refs/heads/api-work
Commit: 1b9fe40d777be7f78aac4cad9635c57b2e51dc37
Parents: 638f2a1
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Sun Feb 5 12:14:03 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Sun Feb 5 14:47:48 2017 +0700
----------------------------------------------------------------------
.../AbstractAllGroupHeadsCollector.cs | 14 +++++++-------
src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs | 6 +++---
.../AbstractDistinctValuesCollector.cs | 4 ++--
.../AbstractFirstPassGroupingCollector.cs | 6 +++---
.../AbstractGroupFacetCollector.cs | 4 ++--
.../AbstractSecondPassGroupingCollector.cs | 2 +-
src/Lucene.Net.Grouping/BlockGroupingCollector.cs | 2 +-
.../Function/FunctionFirstPassGroupingCollector.cs | 2 +-
.../Function/FunctionSecondPassGroupingCollector.cs | 2 +-
src/Lucene.Net.Grouping/GroupingSearch.cs | 8 ++++----
.../Term/TermAllGroupHeadsCollector.cs | 2 +-
.../Term/TermDistinctValuesCollector.cs | 2 +-
.../Term/TermFirstPassGroupingCollector.cs | 2 +-
13 files changed, 28 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractAllGroupHeadsCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractAllGroupHeadsCollector.cs b/src/Lucene.Net.Grouping/AbstractAllGroupHeadsCollector.cs
index 3f6d46b..beba4d5 100644
--- a/src/Lucene.Net.Grouping/AbstractAllGroupHeadsCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractAllGroupHeadsCollector.cs
@@ -99,7 +99,7 @@ namespace Lucene.Net.Search.Grouping
/// </para>
/// </summary>
/// <param name="doc">The document to retrieve the group head for.</param>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
protected override abstract void RetrieveGroupHeadAndAddIfNotExist(int doc);
/// <summary>
@@ -194,14 +194,14 @@ namespace Lucene.Net.Search.Grouping
/// -1 if the specified document wasn't competitive against the current most relevant document, 1 if the
/// specified document was competitive against the current most relevant document. Otherwise 0.
/// </returns>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
public abstract int Compare(int compIDX, int doc);
/// <summary>
/// Updates the current most relevant document with the specified document.
/// </summary>
/// <param name="doc">The specified document</param>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
public abstract void UpdateDocHead(int doc);
}
@@ -233,15 +233,15 @@ namespace Lucene.Net.Search.Grouping
public abstract int GroupHeadsCount { get; }
/// <summary>
- /// Returns the group head and puts it into <see cref="TemporalResult"/>.
+ /// Returns the group head and puts it into <see cref="AbstractAllGroupHeadsCollector{GH}.TemporalResult"/>.
/// If the group head wasn't encountered before then it will be added to the collected group heads.
/// <para>
- /// The <see cref="TemporalResult.stop"/> property will be <c>true</c> if the group head wasn't encountered before
+ /// The <see cref="AbstractAllGroupHeadsCollector{GH}.TemporalResult.Stop"/> property will be <c>true</c> if the group head wasn't encountered before
/// otherwise <c>false</c>.
/// </para>
/// </summary>
/// <param name="doc">The document to retrieve the group head for.</param>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
protected abstract void RetrieveGroupHeadAndAddIfNotExist(int doc);
@@ -274,7 +274,7 @@ namespace Lucene.Net.Search.Grouping
/// Called before collecting from each <see cref="AtomicReaderContext"/>. All doc ids in
/// <see cref="Collect(int)"/> will correspond to <see cref="Index.IndexReaderContext.Reader"/>.
///
- /// Add <see cref="AtomicReaderContext#docBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
+ /// Add <see cref="AtomicReaderContext.DocBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
/// internal document id to re-base ids in <see cref="Collect(int)"/>.
/// </summary>
/// <param name="context">next atomic reader context </param>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs b/src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs
index af10a0d..27e8104 100644
--- a/src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractAllGroupsCollector.cs
@@ -52,7 +52,7 @@ namespace Lucene.Net.Search.Grouping
/// <summary>
/// Returns the group values
/// <para>
- /// This is an unordered collections of group values. For each group that matched the query there is a <see cref="BytesRef"/>
+ /// This is an unordered collections of group values. For each group that matched the query there is a <see cref="Util.BytesRef"/>
/// representing a group value.
/// </para>
/// </summary>
@@ -87,7 +87,7 @@ namespace Lucene.Net.Search.Grouping
/// Called before collecting from each <see cref="AtomicReaderContext"/>. All doc ids in
/// <see cref="Collect(int)"/> will correspond to <see cref="Index.IndexReaderContext.Reader"/>.
///
- /// Add <see cref="AtomicReaderContext#docBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
+ /// Add <see cref="AtomicReaderContext.DocBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
/// internal document id to re-base ids in <see cref="Collect(int)"/>.
/// </summary>
/// <param name="context">next atomic reader context </param>
@@ -115,7 +115,7 @@ namespace Lucene.Net.Search.Grouping
/// <summary>
/// Returns the group values
/// <para>
- /// This is an unordered collections of group values. For each group that matched the query there is a <see cref="BytesRef"/>
+ /// This is an unordered collections of group values. For each group that matched the query there is a <see cref="Util.BytesRef"/>
/// representing a group value.
/// </para>
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs b/src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs
index 2ad7595..8f586ed 100644
--- a/src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractDistinctValuesCollector.cs
@@ -66,7 +66,7 @@ namespace Lucene.Net.Search.Grouping
/// Called before collecting from each <see cref="AtomicReaderContext"/>. All doc ids in
/// <see cref="Collect(int)"/> will correspond to <see cref="Index.IndexReaderContext.Reader"/>.
///
- /// Add <see cref="AtomicReaderContext#docBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
+ /// Add <see cref="AtomicReaderContext.DocBase"/> to the current <see cref="Index.IndexReaderContext.Reader"/>'s
/// internal document id to re-base ids in <see cref="Collect(int)"/>.
/// </summary>
/// <param name="context">next atomic reader context </param>
@@ -85,7 +85,7 @@ namespace Lucene.Net.Search.Grouping
private AbstractDistinctValuesCollector() { }
/// <summary>
- /// Returned by <see cref="AbstractDistinctValuesCollector.GetGroups()"/>,
+ /// Returned by <see cref="AbstractDistinctValuesCollector{GC}.Groups"/>,
/// representing the value and set of distinct values for the group.
/// </summary>
/// <typeparam name="TGroupValue"></typeparam>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs b/src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs
index f4bc5fd..126596b 100644
--- a/src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractFirstPassGroupingCollector.cs
@@ -64,7 +64,7 @@ namespace Lucene.Net.Search.Grouping
/// Sort.RELEVANCE.
/// </param>
/// <param name="topNGroups">How many top groups to keep.</param>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
public AbstractFirstPassGroupingCollector(Sort groupSort, int topNGroups)
{
if (topNGroups < 1)
@@ -101,7 +101,7 @@ namespace Lucene.Net.Search.Grouping
/// number of unique groups collected is <= offset.
/// </summary>
/// <param name="groupOffset">The offset in the collected groups</param>
- /// <param name="fillFields">Whether to fill to <see cref="SearchGroup.sortValues"/></param>
+ /// <param name="fillFields">Whether to fill to <see cref="SearchGroup{TGroupValue}.SortValues"/></param>
/// <returns>top groups, starting from offset</returns>
public virtual IEnumerable<ISearchGroup<TGroupValue>> GetTopGroups(int groupOffset, bool fillFields)
{
@@ -427,7 +427,7 @@ namespace Lucene.Net.Search.Grouping
/// number of unique groups collected is <= offset.
/// </summary>
/// <param name="groupOffset">The offset in the collected groups</param>
- /// <param name="fillFields">Whether to fill to <see cref="SearchGroup.sortValues"/></param>
+ /// <param name="fillFields">Whether to fill to <see cref="SearchGroup{TGroupValue}.SortValues"/></param>
/// <returns>top groups, starting from offset</returns>
/// <remarks>
/// LUCENENET NOTE: We must use <see cref="IEnumerable{TGroupValue}"/> rather than
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractGroupFacetCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractGroupFacetCollector.cs b/src/Lucene.Net.Grouping/AbstractGroupFacetCollector.cs
index 4ccca43..ad2c0c1 100644
--- a/src/Lucene.Net.Grouping/AbstractGroupFacetCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractGroupFacetCollector.cs
@@ -57,7 +57,7 @@ namespace Lucene.Net.Search.Grouping
/// are sorted lexicographically in ascending order.
/// </param>
/// <returns>grouped facet results</returns>
- /// <exception cref="IOException">If I/O related errors occur during merging segment grouped facet counts.</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur during merging segment grouped facet counts.</exception>
public virtual GroupedFacetResult MergeSegmentResults(int size, int minCount, bool orderByCount)
{
if (m_segmentFacetCounts != null)
@@ -344,7 +344,7 @@ namespace Lucene.Net.Search.Grouping
/// <summary>
/// Go to next term in this <see cref="AbstractSegmentResult"/> in order to retrieve the grouped facet counts.
/// </summary>
- /// <exception cref="IOException">If I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If I/O related errors occur</exception>
protected internal abstract void NextTerm();
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs b/src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs
index ee75c57..396efc6 100644
--- a/src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/AbstractSecondPassGroupingCollector.cs
@@ -106,7 +106,7 @@ namespace Lucene.Net.Search.Grouping
/// </summary>
/// <param name="doc">The specified doc</param>
/// <returns>the group the specified doc belongs to or <c>null</c> if no group could be retrieved</returns>
- /// <exception cref="IOException">If an I/O related error occurred</exception>
+ /// <exception cref="System.IO.IOException">If an I/O related error occurred</exception>
protected abstract AbstractSecondPassGroupingCollector.SearchGroupDocs<TGroupValue> RetrieveGroup(int doc);
public virtual void SetNextReader(AtomicReaderContext context)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/BlockGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/BlockGroupingCollector.cs b/src/Lucene.Net.Grouping/BlockGroupingCollector.cs
index 165f386..6f38ca3 100644
--- a/src/Lucene.Net.Grouping/BlockGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/BlockGroupingCollector.cs
@@ -369,7 +369,7 @@ namespace Lucene.Net.Search.Grouping
/// </para>
/// </summary>
/// <typeparam name="TGroupValue">The expected return type for group value</typeparam>
- /// <<param name="withinGroupSort">
+ /// <param name="withinGroupSort">
/// The <see cref="Sort"/> used to sort
/// documents within each group. Passing null is
/// allowed, to sort by relevance.
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs b/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs
index 224db45..f389049 100644
--- a/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/Function/FunctionFirstPassGroupingCollector.cs
@@ -50,7 +50,7 @@ namespace Lucene.Net.Search.Grouping.Function
/// <see cref="Sort.RELEVANCE"/>.
/// </param>
/// <param name="topNGroups">How many top groups to keep.</param>
- /// <exception cref="IOException">When I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">When I/O related errors occur</exception>
public FunctionFirstPassGroupingCollector(ValueSource groupByVS, IDictionary /* Map<?, ?> */ vsContext, Sort groupSort, int topNGroups)
: base(groupSort, topNGroups)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs b/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs
index 75222e6..6bd648e 100644
--- a/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/Function/FunctionSecondPassGroupingCollector.cs
@@ -49,7 +49,7 @@ namespace Lucene.Net.Search.Grouping.Function
/// <param name="fillSortFields">Whether to fill the sort values in <see cref="TopGroups{TGroupValueType}.WithinGroupSort"/></param>
/// <param name="groupByVS">The <see cref="ValueSource"/> to group by</param>
/// <param name="vsContext">The value source context</param>
- /// <exception cref="IOException">When I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">When I/O related errors occur</exception>
public FunctionSecondPassGroupingCollector(IEnumerable<ISearchGroup<MutableValue>> searchGroups,
Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, bool getScores, bool getMaxScores,
bool fillSortFields, ValueSource groupByVS, IDictionary /* Map<?, ?> */ vsContext)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/GroupingSearch.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/GroupingSearch.cs b/src/Lucene.Net.Grouping/GroupingSearch.cs
index 0ac877c..c3bcee9 100644
--- a/src/Lucene.Net.Grouping/GroupingSearch.cs
+++ b/src/Lucene.Net.Grouping/GroupingSearch.cs
@@ -104,7 +104,7 @@ namespace Lucene.Net.Search.Grouping
/// <param name="groupOffset">The group offset</param>
/// <param name="groupLimit">The number of groups to return from the specified group offset</param>
/// <returns>the grouped result as a <see cref="ITopGroups{Object}"/> instance</returns>
- /// <exception cref="IOException">If any I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If any I/O related errors occur</exception>
public virtual ITopGroups<object> Search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)
{
return Search<object>(searcher, null, query, groupOffset, groupLimit);
@@ -120,7 +120,7 @@ namespace Lucene.Net.Search.Grouping
/// <param name="groupOffset">The group offset</param>
/// <param name="groupLimit">The number of groups to return from the specified group offset</param>
/// <returns>the grouped result as a <see cref="ITopGroups{Object}"/> instance</returns>
- /// <exception cref="IOException">If any I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If any I/O related errors occur</exception>
public virtual ITopGroups<TGroupValue> Search<TGroupValue>(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)
{
return Search<TGroupValue>(searcher, null, query, groupOffset, groupLimit);
@@ -135,7 +135,7 @@ namespace Lucene.Net.Search.Grouping
/// <param name="groupOffset">The group offset</param>
/// <param name="groupLimit">The number of groups to return from the specified group offset</param>
/// <returns>the grouped result as a <see cref="ITopGroups{Object}"/> instance</returns>
- /// <exception cref="IOException">If any I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If any I/O related errors occur</exception>
public virtual ITopGroups<object> Search(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)
{
if (groupFunction != null)
@@ -166,7 +166,7 @@ namespace Lucene.Net.Search.Grouping
/// <param name="groupOffset">The group offset</param>
/// <param name="groupLimit">The number of groups to return from the specified group offset</param>
/// <returns>the grouped result as a <see cref="ITopGroups{Object}"/> instance</returns>
- /// <exception cref="IOException">If any I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">If any I/O related errors occur</exception>
public virtual ITopGroups<TGroupValue> Search<TGroupValue>(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit)
{
if (groupField != null || groupFunction != null)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/Term/TermAllGroupHeadsCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/Term/TermAllGroupHeadsCollector.cs b/src/Lucene.Net.Grouping/Term/TermAllGroupHeadsCollector.cs
index 8961fed..e3c68dc 100644
--- a/src/Lucene.Net.Grouping/Term/TermAllGroupHeadsCollector.cs
+++ b/src/Lucene.Net.Grouping/Term/TermAllGroupHeadsCollector.cs
@@ -62,7 +62,7 @@ namespace Lucene.Net.Search.Grouping.Terms
private TermAllGroupHeadsCollector() { }
/// <summary>
- /// Creates an <see cref=AbstractAllGroupHeadsCollector""/> instance based on the supplied arguments.
+ /// Creates an <see cref="AbstractAllGroupHeadsCollector"/> instance based on the supplied arguments.
/// This factory method decides with implementation is best suited.
/// <para>
/// Delegates to <see cref="Create(string, Sort, int)"/> with an initialSize of 128.
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/Term/TermDistinctValuesCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/Term/TermDistinctValuesCollector.cs b/src/Lucene.Net.Grouping/Term/TermDistinctValuesCollector.cs
index 704ab70..fd186cb 100644
--- a/src/Lucene.Net.Grouping/Term/TermDistinctValuesCollector.cs
+++ b/src/Lucene.Net.Grouping/Term/TermDistinctValuesCollector.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Search.Grouping.Terms
*/
/// <summary>
- /// A term based implementation of <see cref="AbstractDistinctValuesCollector{TermDistinctValuesCollector.GroupCount}"/> that relies
+ /// A term based implementation of <see cref="T:AbstractDistinctValuesCollector{TermDistinctValuesCollector.GroupCount}"/> that relies
/// on <see cref="SortedDocValues"/> to count the distinct values per group.
///
/// @lucene.experimental
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b9fe40d/src/Lucene.Net.Grouping/Term/TermFirstPassGroupingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Grouping/Term/TermFirstPassGroupingCollector.cs b/src/Lucene.Net.Grouping/Term/TermFirstPassGroupingCollector.cs
index afefb78..f2e31a0 100644
--- a/src/Lucene.Net.Grouping/Term/TermFirstPassGroupingCollector.cs
+++ b/src/Lucene.Net.Grouping/Term/TermFirstPassGroupingCollector.cs
@@ -54,7 +54,7 @@ namespace Lucene.Net.Search.Grouping.Terms
/// <param name="topNGroups">
/// How many top groups to keep.
/// </param>
- /// <exception cref="IOException">When I/O related errors occur</exception>
+ /// <exception cref="System.IO.IOException">When I/O related errors occur</exception>
public TermFirstPassGroupingCollector(string groupField, Sort groupSort, int topNGroups)
: base(groupSort, topNGroups)
{