Lucene.Net.Analysis.Es 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/3d97e6a2 Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/3d97e6a2 Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/3d97e6a2 Branch: refs/heads/api-work Commit: 3d97e6a23826c426ad94420e39a225a510082066 Parents: d2a16d0 Author: Shad Storhaug <[email protected]> Authored: Fri Feb 3 11:29:26 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Fri Feb 3 11:29:26 2017 +0700 ---------------------------------------------------------------------- .../Analysis/Es/SpanishAnalyzer.cs | 23 ++++++++++---------- .../Analysis/Es/SpanishLightStemFilter.cs | 2 +- .../Es/SpanishLightStemFilterFactory.cs | 2 +- .../Analysis/Es/SpanishLightStemmer.cs | 3 +-- 4 files changed, 14 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3d97e6a2/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishAnalyzer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishAnalyzer.cs index edcde59..d6f6707 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishAnalyzer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishAnalyzer.cs @@ -31,13 +31,12 @@ namespace Lucene.Net.Analysis.Es /// <summary> /// <see cref="Analyzer"/> for Spanish. /// <para> - /// <a name="version"/> /// </para> /// <para>You must specify the required <see cref="LuceneVersion"/> - /// compatibility when creating SpanishAnalyzer: - /// <ul> - /// <li> As of 3.6, SpanishLightStemFilter is used for less aggressive stemming. - /// </ul> + /// compatibility when creating <see cref="SpanishAnalyzer"/>: + /// <list type="bullet"> + /// <item> As of 3.6, <see cref="SpanishLightStemFilter"/> is used for less aggressive stemming.</item> + /// </list> /// </para> /// </summary> public sealed class SpanishAnalyzer : StopwordAnalyzerBase @@ -60,7 +59,7 @@ namespace Lucene.Net.Analysis.Es } /// <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 @@ -88,7 +87,7 @@ namespace Lucene.Net.Analysis.Es } /// <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> public SpanishAnalyzer(LuceneVersion matchVersion) : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET) @@ -98,7 +97,7 @@ namespace Lucene.Net.Analysis.Es /// <summary> /// Builds an analyzer with the given stop words. /// </summary> - /// <param name="matchVersion"> lucene compatibility version </param> + /// <param name="matchVersion"> <see cref="LuceneVersion"/> lucene compatibility version </param> /// <param name="stopwords"> a stopword set </param> public SpanishAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords) : this(matchVersion, stopwords, CharArraySet.EMPTY_SET) @@ -110,7 +109,7 @@ namespace Lucene.Net.Analysis.Es /// provided this analyzer will add a <see cref="SetKeywordMarkerFilter"/> before /// stemming. /// </summary> - /// <param name="matchVersion"> lucene compatibility version </param> + /// <param name="matchVersion"> <see cref="LuceneVersion"/> lucene compatibility version </param> /// <param name="stopwords"> a stopword set </param> /// <param name="stemExclusionSet"> a set of terms not to be stemmed </param> public SpanishAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords, CharArraySet stemExclusionSet) @@ -122,13 +121,13 @@ namespace Lucene.Net.Analysis.Es /// <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="SpanishLightStemFilter"/>. </returns> protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3d97e6a2/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilter.cs index b7810fc..16f1461 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilter.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilter.cs @@ -24,7 +24,7 @@ namespace Lucene.Net.Analysis.Es /// 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> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3d97e6a2/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilterFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilterFactory.cs index 31ef33b..f1404a6 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilterFactory.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemFilterFactory.cs @@ -35,7 +35,7 @@ namespace Lucene.Net.Analysis.Es { /// <summary> - /// Creates a new SpanishLightStemFilterFactory </summary> + /// Creates a new <see cref="SpanishLightStemFilterFactory"/> </summary> public SpanishLightStemFilterFactory(IDictionary<string, string> args) : base(args) { if (args.Count > 0) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3d97e6a2/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemmer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemmer.cs index 5560650..3acafc0 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemmer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Es/SpanishLightStemmer.cs @@ -56,13 +56,12 @@ /// Light Stemmer for Spanish /// <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 SpanishLightStemmer { - public virtual int Stem(char[] s, int len) { if (len < 5)
