Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 23D59200C21 for ; Sun, 5 Feb 2017 17:51:40 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 227F6160B48; Sun, 5 Feb 2017 16:51:40 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 32479160B67 for ; Sun, 5 Feb 2017 17:51:38 +0100 (CET) Received: (qmail 85973 invoked by uid 500); 5 Feb 2017 16:51:37 -0000 Mailing-List: contact commits-help@lucenenet.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: lucene-net-dev@lucenenet.apache.org Delivered-To: mailing list commits@lucenenet.apache.org Received: (qmail 85776 invoked by uid 99); 5 Feb 2017 16:51:37 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Feb 2017 16:51:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B3599DFC31; Sun, 5 Feb 2017 16:51:36 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: nightowl888@apache.org To: commits@lucenenet.apache.org Date: Sun, 05 Feb 2017 16:51:40 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [05/27] lucenenet git commit: Lucene.Net.Grouping: fix documentation comment formatting problems archived-at: Sun, 05 Feb 2017 16:51:40 -0000 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 Authored: Sun Feb 5 12:14:03 2017 +0700 Committer: Shad Storhaug 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 /// /// /// The document to retrieve the group head for. - /// If I/O related errors occur + /// If I/O related errors occur protected override abstract void RetrieveGroupHeadAndAddIfNotExist(int doc); /// @@ -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. /// - /// If I/O related errors occur + /// If I/O related errors occur public abstract int Compare(int compIDX, int doc); /// /// Updates the current most relevant document with the specified document. /// /// The specified document - /// If I/O related errors occur + /// If I/O related errors occur public abstract void UpdateDocHead(int doc); } @@ -233,15 +233,15 @@ namespace Lucene.Net.Search.Grouping public abstract int GroupHeadsCount { get; } /// - /// Returns the group head and puts it into . + /// Returns the group head and puts it into . /// If the group head wasn't encountered before then it will be added to the collected group heads. /// - /// The property will be true if the group head wasn't encountered before + /// The property will be true if the group head wasn't encountered before /// otherwise false. /// /// /// The document to retrieve the group head for. - /// If I/O related errors occur + /// If I/O related errors occur protected abstract void RetrieveGroupHeadAndAddIfNotExist(int doc); @@ -274,7 +274,7 @@ namespace Lucene.Net.Search.Grouping /// Called before collecting from each . All doc ids in /// will correspond to . /// - /// Add to the current 's + /// Add to the current 's /// internal document id to re-base ids in . /// /// next atomic reader context 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 /// /// Returns the group values /// - /// This is an unordered collections of group values. For each group that matched the query there is a + /// This is an unordered collections of group values. For each group that matched the query there is a /// representing a group value. /// /// @@ -87,7 +87,7 @@ namespace Lucene.Net.Search.Grouping /// Called before collecting from each . All doc ids in /// will correspond to . /// - /// Add to the current 's + /// Add to the current 's /// internal document id to re-base ids in . /// /// next atomic reader context @@ -115,7 +115,7 @@ namespace Lucene.Net.Search.Grouping /// /// Returns the group values /// - /// This is an unordered collections of group values. For each group that matched the query there is a + /// This is an unordered collections of group values. For each group that matched the query there is a /// representing a group value. /// /// 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 . All doc ids in /// will correspond to . /// - /// Add to the current 's + /// Add to the current 's /// internal document id to re-base ids in . /// /// next atomic reader context @@ -85,7 +85,7 @@ namespace Lucene.Net.Search.Grouping private AbstractDistinctValuesCollector() { } /// - /// Returned by , + /// Returned by , /// representing the value and set of distinct values for the group. /// /// 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. /// /// How many top groups to keep. - /// If I/O related errors occur + /// If I/O related errors occur 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. /// /// The offset in the collected groups - /// Whether to fill to + /// Whether to fill to /// top groups, starting from offset public virtual IEnumerable> GetTopGroups(int groupOffset, bool fillFields) { @@ -427,7 +427,7 @@ namespace Lucene.Net.Search.Grouping /// number of unique groups collected is <= offset. /// /// The offset in the collected groups - /// Whether to fill to + /// Whether to fill to /// top groups, starting from offset /// /// LUCENENET NOTE: We must use 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. /// /// grouped facet results - /// If I/O related errors occur during merging segment grouped facet counts. + /// If I/O related errors occur during merging segment grouped facet counts. public virtual GroupedFacetResult MergeSegmentResults(int size, int minCount, bool orderByCount) { if (m_segmentFacetCounts != null) @@ -344,7 +344,7 @@ namespace Lucene.Net.Search.Grouping /// /// Go to next term in this in order to retrieve the grouped facet counts. /// - /// If I/O related errors occur + /// If I/O related errors occur 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 /// /// The specified doc /// the group the specified doc belongs to or null if no group could be retrieved - /// If an I/O related error occurred + /// If an I/O related error occurred protected abstract AbstractSecondPassGroupingCollector.SearchGroupDocs 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 /// /// /// The expected return type for group value - /// < + /// /// The 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 /// . /// /// How many top groups to keep. - /// When I/O related errors occur + /// When I/O related errors occur 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 /// Whether to fill the sort values in /// The to group by /// The value source context - /// When I/O related errors occur + /// When I/O related errors occur public FunctionSecondPassGroupingCollector(IEnumerable> 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 /// The group offset /// The number of groups to return from the specified group offset /// the grouped result as a instance - /// If any I/O related errors occur + /// If any I/O related errors occur public virtual ITopGroups Search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit) { return Search(searcher, null, query, groupOffset, groupLimit); @@ -120,7 +120,7 @@ namespace Lucene.Net.Search.Grouping /// The group offset /// The number of groups to return from the specified group offset /// the grouped result as a instance - /// If any I/O related errors occur + /// If any I/O related errors occur public virtual ITopGroups Search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit) { return Search(searcher, null, query, groupOffset, groupLimit); @@ -135,7 +135,7 @@ namespace Lucene.Net.Search.Grouping /// The group offset /// The number of groups to return from the specified group offset /// the grouped result as a instance - /// If any I/O related errors occur + /// If any I/O related errors occur public virtual ITopGroups Search(IndexSearcher searcher, Filter filter, Query query, int groupOffset, int groupLimit) { if (groupFunction != null) @@ -166,7 +166,7 @@ namespace Lucene.Net.Search.Grouping /// The group offset /// The number of groups to return from the specified group offset /// the grouped result as a instance - /// If any I/O related errors occur + /// If any I/O related errors occur public virtual ITopGroups Search(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() { } /// - /// Creates an instance based on the supplied arguments. + /// Creates an instance based on the supplied arguments. /// This factory method decides with implementation is best suited. /// /// Delegates to 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 */ /// - /// A term based implementation of that relies + /// A term based implementation of that relies /// on 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 /// /// How many top groups to keep. /// - /// When I/O related errors occur + /// When I/O related errors occur public TermFirstPassGroupingCollector(string groupField, Sort groupSort, int topNGroups) : base(groupSort, topNGroups) {