lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [5/8] lucenenet git commit: Lucene.Net.Analysis.Query refactor: member accessibility and documentation comments
Date Fri, 03 Feb 2017 21:06:40 GMT
Lucene.Net.Analysis.Query refactor: member accessibility and documentation comments


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/bb9de835
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/bb9de835
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/bb9de835

Branch: refs/heads/api-work
Commit: bb9de8354b516b803b402b7dc3da315c6416418e
Parents: 73a3384
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Sat Feb 4 03:39:17 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Sat Feb 4 03:39:17 2017 +0700

----------------------------------------------------------------------
 .../Analysis/Query/QueryAutoStopWordAnalyzer.cs | 49 ++++++++++----------
 1 file changed, 24 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/bb9de835/src/Lucene.Net.Analysis.Common/Analysis/Query/QueryAutoStopWordAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Query/QueryAutoStopWordAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Query/QueryAutoStopWordAnalyzer.cs
index 1b8b913..70f432a 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Query/QueryAutoStopWordAnalyzer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Query/QueryAutoStopWordAnalyzer.cs
@@ -36,7 +36,6 @@ namespace Lucene.Net.Analysis.Query
     /// </summary>
     public sealed class QueryAutoStopWordAnalyzer : AnalyzerWrapper
     {
-
         private readonly Analyzer @delegate;
         private readonly IDictionary<string, HashSet<string>> stopWordsPerField
= new Dictionary<string, HashSet<string>>();
         //The default maximum percentage (40%) of index documents which
@@ -45,78 +44,78 @@ namespace Lucene.Net.Analysis.Query
         private readonly LuceneVersion matchVersion;
 
         /// <summary>
-        /// Creates a new QueryAutoStopWordAnalyzer with stopwords calculated for all
+        /// Creates a new <see cref="QueryAutoStopWordAnalyzer"/> with stopwords calculated
for all
         /// indexed fields from terms with a document frequency percentage greater than
-        /// <see cref="#defaultMaxDocFreqPercent"/>
+        /// <see cref="defaultMaxDocFreqPercent"/>
         /// </summary>
         /// <param name="matchVersion"> Version to be used in <see cref="StopFilter"/>
</param>
-        /// <param name="delegate"> Analyzer whose TokenStream will be filtered </param>
-        /// <param name="indexReader"> IndexReader to identify the stopwords from </param>
-        /// <exception cref="IOException"> Can be thrown while reading from the IndexReader
</exception>
+        /// <param name="delegate"> <see cref="Analyzer"/> whose <see cref="TokenStream"/>
will be filtered </param>
+        /// <param name="indexReader"> <see cref="IndexReader"/> to identify
the stopwords from </param>
+        /// <exception cref="System.IO.IOException"> Can be thrown while reading from
the <see cref="IndexReader"/> </exception>
         public QueryAutoStopWordAnalyzer(LuceneVersion matchVersion, Analyzer @delegate,
IndexReader indexReader)
             : this(matchVersion, @delegate, indexReader, defaultMaxDocFreqPercent)
         {
         }
 
         /// <summary>
-        /// Creates a new QueryAutoStopWordAnalyzer with stopwords calculated for all
+        /// Creates a new <see cref="QueryAutoStopWordAnalyzer"/> with stopwords calculated
for all
         /// indexed fields from terms with a document frequency greater than the given
-        /// maxDocFreq
+        /// <paramref name="maxDocFreq"/>
         /// </summary>
         /// <param name="matchVersion"> Version to be used in <see cref="StopFilter"/>
</param>
-        /// <param name="delegate"> Analyzer whose TokenStream will be filtered </param>
-        /// <param name="indexReader"> IndexReader to identify the stopwords from </param>
+        /// <param name="delegate"> <see cref="Analyzer"/> whose <see cref="TokenStream"/>
will be filtered </param>
+        /// <param name="indexReader"> <see cref="IndexReader"/> to identify
the stopwords from </param>
         /// <param name="maxDocFreq"> Document frequency terms should be above in order
to be stopwords </param>
-        /// <exception cref="IOException"> Can be thrown while reading from the IndexReader
</exception>
+        /// <exception cref="System.IO.IOException"> Can be thrown while reading from
the <see cref="IndexReader"/> </exception>
         public QueryAutoStopWordAnalyzer(LuceneVersion matchVersion, Analyzer @delegate,
IndexReader indexReader, int maxDocFreq)
             : this(matchVersion, @delegate, indexReader, MultiFields.GetIndexedFields(indexReader),
maxDocFreq)
         {
         }
 
         /// <summary>
-        /// Creates a new QueryAutoStopWordAnalyzer with stopwords calculated for all
+        /// Creates a new <see cref="QueryAutoStopWordAnalyzer"/> with stopwords calculated
for all
         /// indexed fields from terms with a document frequency percentage greater than
-        /// the given maxPercentDocs
+        /// the given <paramref name="maxPercentDocs"/>
         /// </summary>
         /// <param name="matchVersion"> Version to be used in <see cref="StopFilter"/>
</param>
-        /// <param name="delegate"> Analyzer whose TokenStream will be filtered </param>
-        /// <param name="indexReader"> IndexReader to identify the stopwords from </param>
+        /// <param name="delegate"> <see cref="Analyzer"/> whose <see cref="TokenStream"/>
will be filtered </param>
+        /// <param name="indexReader"> <see cref="IndexReader"/> to identify
the stopwords from </param>
         /// <param name="maxPercentDocs"> The maximum percentage (between 0.0 and 1.0)
of index documents which
         ///                      contain a term, after which the word is considered to be
a stop word </param>
-        /// <exception cref="IOException"> Can be thrown while reading from the IndexReader
</exception>
+        /// <exception cref="System.IO.IOException"> Can be thrown while reading from
the <see cref="IndexReader"/> </exception>
         public QueryAutoStopWordAnalyzer(LuceneVersion matchVersion, Analyzer @delegate,
IndexReader indexReader, float maxPercentDocs)
             : this(matchVersion, @delegate, indexReader, MultiFields.GetIndexedFields(indexReader),
maxPercentDocs)
         {
         }
 
         /// <summary>
-        /// Creates a new QueryAutoStopWordAnalyzer with stopwords calculated for the
+        /// Creates a new <see cref="QueryAutoStopWordAnalyzer"/> with stopwords calculated
for the
         /// given selection of fields from terms with a document frequency percentage
-        /// greater than the given maxPercentDocs
+        /// greater than the given <paramref name="maxPercentDocs"/>
         /// </summary>
         /// <param name="matchVersion"> Version to be used in <see cref="StopFilter"/>
</param>
-        /// <param name="delegate"> Analyzer whose TokenStream will be filtered </param>
-        /// <param name="indexReader"> IndexReader to identify the stopwords from </param>
+        /// <param name="delegate"> <see cref="Analyzer"/> whose <see cref="TokenStream"/>
will be filtered </param>
+        /// <param name="indexReader"> <see cref="IndexReader"/> to identify
the stopwords from </param>
         /// <param name="fields"> Selection of fields to calculate stopwords for </param>
         /// <param name="maxPercentDocs"> The maximum percentage (between 0.0 and 1.0)
of index documents which
         ///                      contain a term, after which the word is considered to be
a stop word </param>
-        /// <exception cref="IOException"> Can be thrown while reading from the IndexReader
</exception>
+        /// <exception cref="System.IO.IOException"> Can be thrown while reading from
the <see cref="IndexReader"/> </exception>
         public QueryAutoStopWordAnalyzer(LuceneVersion matchVersion, Analyzer @delegate,
IndexReader indexReader, ICollection<string> fields, float maxPercentDocs)
             : this(matchVersion, @delegate, indexReader, fields, (int)(indexReader.NumDocs
* maxPercentDocs))
         {
         }
 
         /// <summary>
-        /// Creates a new QueryAutoStopWordAnalyzer with stopwords calculated for the
+        /// Creates a new <see cref="QueryAutoStopWordAnalyzer"/> with stopwords calculated
for the
         /// given selection of fields from terms with a document frequency greater than
-        /// the given maxDocFreq
+        /// the given <paramref name="maxDocFreq"/>
         /// </summary>
         /// <param name="matchVersion"> Version to be used in <see cref="StopFilter"/>
</param>
         /// <param name="delegate"> Analyzer whose TokenStream will be filtered </param>
-        /// <param name="indexReader"> IndexReader to identify the stopwords from </param>
+        /// <param name="indexReader"> <see cref="IndexReader"/> to identify
the stopwords from </param>
         /// <param name="fields"> Selection of fields to calculate stopwords for </param>
         /// <param name="maxDocFreq"> Document frequency terms should be above in order
to be stopwords </param>
-        /// <exception cref="IOException"> Can be thrown while reading from the IndexReader
</exception>
+        /// <exception cref="System.IO.IOException"> Can be thrown while reading from
the <see cref="IndexReader"/> </exception>
         public QueryAutoStopWordAnalyzer(LuceneVersion matchVersion, Analyzer @delegate,
IndexReader indexReader, ICollection<string> fields, int maxDocFreq)
             : base(@delegate.Strategy)
         {


Mime
View raw message