Lucene.Net.Analysis.Sv 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/b158f914 Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/b158f914 Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/b158f914 Branch: refs/heads/api-work Commit: b158f9146c606334c6b40403258ec9541c50a391 Parents: ab69b43 Author: Shad Storhaug <[email protected]> Authored: Sat Feb 4 12:53:47 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Sat Feb 4 12:53:47 2017 +0700 ---------------------------------------------------------------------- .../Analysis/Sv/SwedishAnalyzer.cs | 17 +++++++++-------- .../Analysis/Sv/SwedishLightStemFilter.cs | 5 +++-- .../Analysis/Sv/SwedishLightStemFilterFactory.cs | 6 +++--- .../Analysis/Sv/SwedishLightStemmer.cs | 3 +-- 4 files changed, 16 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b158f914/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishAnalyzer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishAnalyzer.cs index 7a334a7..d2572ba 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishAnalyzer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishAnalyzer.cs @@ -51,7 +51,7 @@ namespace Lucene.Net.Analysis.Sv } /// <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 @@ -79,10 +79,11 @@ namespace Lucene.Net.Analysis.Sv } /// <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 SwedishAnalyzer(LuceneVersion matchVersion) - : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET) + : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET) { } @@ -92,7 +93,7 @@ namespace Lucene.Net.Analysis.Sv /// <param name="matchVersion"> lucene compatibility version </param> /// <param name="stopwords"> a stopword set </param> public SwedishAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords) - : this(matchVersion, stopwords, CharArraySet.EMPTY_SET) + : this(matchVersion, stopwords, CharArraySet.EMPTY_SET) { } @@ -105,7 +106,7 @@ namespace Lucene.Net.Analysis.Sv /// <param name="stopwords"> a stopword set </param> /// <param name="stemExclusionSet"> a set of terms not to be stemmed </param> public SwedishAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords, CharArraySet stemExclusionSet) - : base(matchVersion, stopwords) + : base(matchVersion, stopwords) { this.stemExclusionSet = CharArraySet.UnmodifiableSet(CharArraySet.Copy(matchVersion, stemExclusionSet)); } @@ -113,13 +114,13 @@ namespace Lucene.Net.Analysis.Sv /// <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="LowerCaseFilter"/>, <see cref="StopFilter"/> - /// , <see cref="SetKeywordMarkerFilter"/> if a stem exclusion set is + /// <see cref="StandardFilter"/>, <see cref="LowerCaseFilter"/>, <see cref="StopFilter"/>, + /// <see cref="SetKeywordMarkerFilter"/> if a stem exclusion set is /// provided and <see cref="SnowballFilter"/>. </returns> protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b158f914/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilter.cs index 356469e..df8b2f3 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilter.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilter.cs @@ -25,7 +25,7 @@ namespace Lucene.Net.Analysis.Sv /// 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> @@ -35,7 +35,8 @@ namespace Lucene.Net.Analysis.Sv private readonly ICharTermAttribute termAtt; private readonly IKeywordAttribute keywordAttr; - public SwedishLightStemFilter(TokenStream input) : base(input) + public SwedishLightStemFilter(TokenStream input) + : base(input) { termAtt = AddAttribute<ICharTermAttribute>(); keywordAttr = AddAttribute<IKeywordAttribute>(); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b158f914/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilterFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilterFactory.cs index 11ca0ab..5fcdedf 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilterFactory.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemFilterFactory.cs @@ -34,10 +34,10 @@ namespace Lucene.Net.Analysis.Sv /// </summary> public class SwedishLightStemFilterFactory : TokenFilterFactory { - /// <summary> - /// Creates a new SwedishLightStemFilterFactory </summary> - public SwedishLightStemFilterFactory(IDictionary<string, string> args) : base(args) + /// Creates a new <see cref="SwedishLightStemFilterFactory"/> </summary> + public SwedishLightStemFilterFactory(IDictionary<string, string> args) + : base(args) { if (args.Count > 0) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/b158f914/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemmer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemmer.cs index f9ff21c..1c5d082 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemmer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Sv/SwedishLightStemmer.cs @@ -59,13 +59,12 @@ namespace Lucene.Net.Analysis.Sv /// Light Stemmer for Swedish. /// <para> /// This stemmer implements the algorithm described in: - /// <i>Report on CLEF-2003 Monolingual Tracks</i> + /// <c>Report on CLEF-2003 Monolingual Tracks</c> /// Jacques Savoy /// </para> /// </summary> public class SwedishLightStemmer { - public virtual int Stem(char[] s, int len) { if (len > 4 && s[len - 1] == 's')
