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/03 17:51:09 UTC

[03/11] lucenenet git commit: Lucene.Net.Analysis.It refactor: member accessibility and documentation comments

Lucene.Net.Analysis.It 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/0b3f976b
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/0b3f976b
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/0b3f976b

Branch: refs/heads/api-work
Commit: 0b3f976bcd72cd302c4f3586dfb23c29a50a3496
Parents: 6d272fe
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Fri Feb 3 17:45:31 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Fri Feb 3 17:45:31 2017 +0700

----------------------------------------------------------------------
 .../Analysis/It/ItalianAnalyzer.cs              | 32 +++++++++-----------
 .../Analysis/It/ItalianLightStemFilter.cs       |  4 +--
 .../It/ItalianLightStemFilterFactory.cs         |  6 ++--
 .../Analysis/It/ItalianLightStemmer.cs          |  3 +-
 4 files changed, 20 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/0b3f976b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianAnalyzer.cs
index be81d75..e9ccce6 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianAnalyzer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianAnalyzer.cs
@@ -31,16 +31,13 @@ namespace Lucene.Net.Analysis.It
 
     /// <summary>
     /// <see cref="Analyzer"/> for Italian.
-    /// <para>
-    /// <a name="version"/>
-    /// </para>
     /// <para>You must specify the required <see cref="LuceneVersion"/>
-    /// compatibility when creating ItalianAnalyzer:
-    /// <ul>
-    ///   <li> As of 3.6, ItalianLightStemFilter is used for less aggressive stemming.
-    ///   <li> As of 3.2, ElisionFilter with a set of Italian 
-    ///        contractions is used by default.
-    /// </ul>
+    /// compatibility when creating <see cref="ItalianAnalyzer"/>:
+    /// <list type="bullet">
+    ///     <item> As of 3.6, <see cref="ItalianLightStemFilter"/> is used for less aggressive stemming.</item>
+    ///     <item> As of 3.2, <see cref="ElisionFilter"/> with a set of Italian 
+    ///        contractions is used by default.</item>
+    /// </list>
     /// </para>
     /// </summary>
     public sealed class ItalianAnalyzer : StopwordAnalyzerBase
@@ -70,7 +67,7 @@ namespace Lucene.Net.Analysis.It
         }
 
         /// <summary>
-        /// Atomically loads the DEFAULT_STOP_SET in a lazy fashion once the outer class 
+        /// Atomically loads the <see cref="DEFAULT_STOP_SET"/> in a lazy fashion once the outer class 
         /// accesses the static final set the first time.;
         /// </summary>
         private class DefaultSetHolder
@@ -98,10 +95,11 @@ namespace Lucene.Net.Analysis.It
         }
 
         /// <summary>
-        /// Builds an analyzer with the default stop words: <see cref="#DEFAULT_STOPWORD_FILE"/>.
+        /// Builds an analyzer with the default stop words: <see cref="DEFAULT_STOPWORD_FILE"/>.
         /// </summary>
+        /// <param name="matchVersion"> lucene compatibility version </param>
         public ItalianAnalyzer(LuceneVersion matchVersion)
-              : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET)
+            : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET)
         {
         }
 
@@ -111,7 +109,7 @@ namespace Lucene.Net.Analysis.It
         /// <param name="matchVersion"> lucene compatibility version </param>
         /// <param name="stopwords"> a stopword set </param>
         public ItalianAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords)
-              : this(matchVersion, stopwords, CharArraySet.EMPTY_SET)
+            : this(matchVersion, stopwords, CharArraySet.EMPTY_SET)
         {
         }
 
@@ -124,7 +122,7 @@ namespace Lucene.Net.Analysis.It
         /// <param name="stopwords"> a stopword set </param>
         /// <param name="stemExclusionSet"> a set of terms not to be stemmed </param>
         public ItalianAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords, CharArraySet stemExclusionSet)
-              : base(matchVersion, stopwords)
+            : base(matchVersion, stopwords)
         {
             this.stemExclusionSet = CharArraySet.UnmodifiableSet(CharArraySet.Copy(matchVersion, stemExclusionSet));
         }
@@ -132,13 +130,13 @@ namespace Lucene.Net.Analysis.It
         /// <summary>
         /// Creates a
         /// <see cref="Analyzer.TokenStreamComponents"/>
-        /// which tokenizes all the text in the provided <see cref="Reader"/>.
+        /// which tokenizes all the text in the provided <see cref="TextReader"/>.
         /// </summary>
         /// <returns> A
         ///         <see cref="Analyzer.TokenStreamComponents"/>
         ///         built from an <see cref="StandardTokenizer"/> filtered with
-        ///         <see cref="StandardFilter"/>, <see cref="ElisionFilter"/>, <see cref="LowerCaseFilter"/>, <see cref="StopFilter"/>
-        ///         , <see cref="SetKeywordMarkerFilter"/> if a stem exclusion set is
+        ///         <see cref="StandardFilter"/>, <see cref="ElisionFilter"/>, <see cref="LowerCaseFilter"/>, <see cref="StopFilter"/>,
+        ///         <see cref="SetKeywordMarkerFilter"/> if a stem exclusion set is
         ///         provided and <see cref="ItalianLightStemFilter"/>. </returns>
         protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/0b3f976b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilter.cs
index f86d45d..ca692e1 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilter.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Analysis.It
     /// words.
     /// <para>
     /// To prevent terms from being stemmed use an instance of
-    /// <see cref="SetKeywordMarkerFilter"/> or a custom <see cref="TokenFilter"/> that sets
+    /// <see cref="Miscellaneous.SetKeywordMarkerFilter"/> or a custom <see cref="TokenFilter"/> that sets
     /// the <see cref="KeywordAttribute"/> before this <see cref="TokenStream"/>.
     /// </para>
     /// </summary>
@@ -36,7 +36,7 @@ namespace Lucene.Net.Analysis.It
         private readonly IKeywordAttribute keywordAttr;
 
         public ItalianLightStemFilter(TokenStream input)
-              : base(input)
+            : base(input)
         {
             termAtt = AddAttribute<ICharTermAttribute>();
             keywordAttr = AddAttribute<IKeywordAttribute>();

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/0b3f976b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilterFactory.cs
index 1ea8ee5..5dd8080 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemFilterFactory.cs
@@ -1,6 +1,5 @@
 \ufeffusing Lucene.Net.Analysis.Util;
 using System.Collections.Generic;
-using System.IO;
 
 namespace Lucene.Net.Analysis.It
 {
@@ -34,11 +33,10 @@ namespace Lucene.Net.Analysis.It
     /// </summary>
     public class ItalianLightStemFilterFactory : TokenFilterFactory
     {
-
         /// <summary>
-        /// Creates a new ItalianLightStemFilterFactory </summary>
+        /// Creates a new <see cref="ItalianLightStemFilterFactory"/> </summary>
         public ItalianLightStemFilterFactory(IDictionary<string, string> args)
-              : base(args)
+            : base(args)
         {
             if (args.Count > 0)
             {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/0b3f976b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemmer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemmer.cs
index 84c9a83..9eb799d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemmer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/It/ItalianLightStemmer.cs
@@ -58,13 +58,12 @@ namespace Lucene.Net.Analysis.It
     /// Light Stemmer for Italian.
     /// <para>
     /// This stemmer implements the algorithm described in:
-    /// <i>Report on CLEF-2001 Experiments</i>
+    /// <c>Report on CLEF-2001 Experiments</c>
     /// Jacques Savoy
     /// </para>
     /// </summary>
     public class ItalianLightStemmer
     {
-
         public virtual int Stem(char[] s, int len)
         {
             if (len < 6)