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 04:41:57 UTC
[10/13] lucenenet git commit: Lucene.Net.Analysis.El refactor: member
accessibility and documentation comments
Lucene.Net.Analysis.El 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/d2a16d03
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/d2a16d03
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/d2a16d03
Branch: refs/heads/api-work
Commit: d2a16d0312c64768c56e8740663caee18840ce21
Parents: 217f113
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Fri Feb 3 11:22:44 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Fri Feb 3 11:22:44 2017 +0700
----------------------------------------------------------------------
.../Analysis/El/GreekAnalyzer.cs | 23 +++++++--------
.../Analysis/El/GreekLowerCaseFilter.cs | 15 +++++-----
.../Analysis/El/GreekLowerCaseFilterFactory.cs | 3 +-
.../Analysis/El/GreekStemFilter.cs | 4 +--
.../Analysis/El/GreekStemFilterFactory.cs | 3 +-
.../Analysis/El/GreekStemmer.cs | 31 ++++++++++----------
6 files changed, 36 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekAnalyzer.cs
index 56024bd..4ea3845 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekAnalyzer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekAnalyzer.cs
@@ -31,18 +31,15 @@ namespace Lucene.Net.Analysis.El
/// that will not be indexed at all).
/// A default set of stopwords is used unless an alternative list is specified.
/// </para>
- ///
- /// <a name="version"/>
/// <para>You must specify the required <see cref="LuceneVersion"/>
- /// compatibility when creating GreekAnalyzer:
- /// <ul>
- /// <li> As of 3.1, StandardFilter and GreekStemmer are used by default.
- /// <li> As of 2.9, StopFilter preserves position
- /// increments
- /// </ul>
- ///
+ /// compatibility when creating <see cref="GreekAnalyzer"/>:
+ /// <list type="bullet">
+ /// <item> As of 3.1, StandardFilter and GreekStemmer are used by default.</item>
+ /// <item> As of 2.9, StopFilter preserves position
+ /// increments</item>
+ /// </list>
/// </para>
- /// <para><b>NOTE</b>: This class uses the same <see cref="LuceneVersion"/>
+ /// <para><c>NOTE</c>: This class uses the same <see cref="LuceneVersion"/>
/// dependent settings as <see cref="StandardAnalyzer"/>.</para>
/// </summary>
public sealed class GreekAnalyzer : StopwordAnalyzerBase
@@ -85,7 +82,7 @@ namespace Lucene.Net.Analysis.El
/// <summary>
/// Builds an analyzer with the default stop words. </summary>
/// <param name="matchVersion"> Lucene compatibility version,
- /// See <a href="#version">above</a> </param>
+ /// See <see cref="LuceneVersion"/> </param>
public GreekAnalyzer(LuceneVersion matchVersion)
: this(matchVersion, DefaultSetHolder.DEFAULT_SET)
{
@@ -100,7 +97,7 @@ namespace Lucene.Net.Analysis.El
/// </para>
/// </summary>
/// <param name="matchVersion"> Lucene compatibility version,
- /// See <a href="#version">above</a> </param>
+ /// See <see cref="LuceneVersion"/> </param>
/// <param name="stopwords"> a stopword set </param>
public GreekAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords)
: base(matchVersion, stopwords)
@@ -110,7 +107,7 @@ namespace Lucene.Net.Analysis.El
/// <summary>
/// Creates
/// <see cref="Analyzer.TokenStreamComponents"/>
- /// used to tokenize all the text in the provided <see cref="Reader"/>.
+ /// used to tokenize all the text in the provided <see cref="TextReader"/>.
/// </summary>
/// <returns> <see cref="Analyzer.TokenStreamComponents"/>
/// built from a <see cref="StandardTokenizer"/> filtered with
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilter.cs
index 559e15e..69cb9f7 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilter.cs
@@ -25,12 +25,11 @@ namespace Lucene.Net.Analysis.El
/// <summary>
/// Normalizes token text to lower case, removes some Greek diacritics,
/// and standardizes final sigma to sigma.
- /// <a name="version"/>
/// <para>You must specify the required <see cref="LuceneVersion"/>
- /// compatibility when creating GreekLowerCaseFilter:
- /// <ul>
- /// <li> As of 3.1, supplementary characters are properly lowercased.
- /// </ul>
+ /// compatibility when creating <see cref="GreekLowerCaseFilter"/>:
+ /// <list type="bullet">
+ /// <item> As of 3.1, supplementary characters are properly lowercased.</item>
+ /// </list>
/// </para>
/// </summary>
public sealed class GreekLowerCaseFilter : TokenFilter
@@ -39,11 +38,11 @@ namespace Lucene.Net.Analysis.El
private readonly CharacterUtils charUtils;
/// <summary>
- /// Create a GreekLowerCaseFilter that normalizes Greek token text.
+ /// Create a <see cref="GreekLowerCaseFilter"/> that normalizes Greek token text.
/// </summary>
/// <param name="matchVersion"> Lucene compatibility version,
- /// See <a href="#version">above</a> </param>
- /// <param name="in"> TokenStream to filter </param>
+ /// See <see cref="LuceneVersion"/> </param>
+ /// <param name="in"> <see cref="TokenStream"/> to filter </param>
public GreekLowerCaseFilter(LuceneVersion matchVersion, TokenStream @in)
: base(@in)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilterFactory.cs
index 2e2daee..65fb382 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekLowerCaseFilterFactory.cs
@@ -32,9 +32,8 @@ namespace Lucene.Net.Analysis.El
/// </summary>
public class GreekLowerCaseFilterFactory : TokenFilterFactory, IMultiTermAwareComponent
{
-
/// <summary>
- /// Creates a new GreekLowerCaseFilterFactory </summary>
+ /// Creates a new <see cref="GreekLowerCaseFilterFactory"/> </summary>
public GreekLowerCaseFilterFactory(IDictionary<string, string> args) : base(args)
{
AssureMatchVersion();
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilter.cs
index 39b77f9..94566f1 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilter.cs
@@ -24,13 +24,13 @@ namespace Lucene.Net.Analysis.El
/// 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>
/// <para>
/// NOTE: Input is expected to be casefolded for Greek (including folding of final
/// sigma to sigma), and with diacritics removed. This can be achieved by using
- /// either <see cref="GreekLowerCaseFilter"/> or ICUFoldingFilter before GreekStemFilter.
+ /// either <see cref="GreekLowerCaseFilter"/> or ICUFoldingFilter before <see cref="GreekStemFilter"/>.
/// @lucene.experimental
/// </para>
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilterFactory.cs
index c09df42..c916e8f 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemFilterFactory.cs
@@ -33,9 +33,8 @@ namespace Lucene.Net.Analysis.El
/// </summary>
public class GreekStemFilterFactory : TokenFilterFactory
{
-
/// <summary>
- /// Creates a new GreekStemFilterFactory </summary>
+ /// Creates a new <see cref="GreekStemFilterFactory"/> </summary>
public GreekStemFilterFactory(IDictionary<string, string> args)
: base(args)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/d2a16d03/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemmer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemmer.cs
index 4e6dda3..1a5e8b3 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemmer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/El/GreekStemmer.cs
@@ -22,8 +22,8 @@ namespace Lucene.Net.Analysis.El
*/
/// <summary>
- /// A stemmer for Greek words, according to: <i>Development of a Stemmer for the
- /// Greek Language.</i> Georgios Ntais
+ /// A stemmer for Greek words, according to: <c>Development of a Stemmer for the
+ /// Greek Language.</c> Georgios Ntais
/// <para>
/// NOTE: Input is expected to be casefolded for Greek (including folding of final
/// sigma to sigma), and with diacritics removed. This can be achieved with
@@ -33,13 +33,12 @@ namespace Lucene.Net.Analysis.El
/// </summary>
public class GreekStemmer
{
-
/// <summary>
- /// Stems a word contained in a leading portion of a char[] array.
+ /// Stems a word contained in a leading portion of a <see cref="char[]"/> array.
/// The word is passed through a number of rules that modify it's length.
/// </summary>
- /// <param name="s"> A char[] array that contains the word to be stemmed. </param>
- /// <param name="len"> The length of the char[] array. </param>
+ /// <param name="s"> A <see cref="char[]"/> array that contains the word to be stemmed. </param>
+ /// <param name="len"> The length of the <see cref="char[]"/> array. </param>
/// <returns> The new length of the stemmed word. </returns>
public virtual int Stem(char[] s, int len)
{
@@ -77,7 +76,7 @@ namespace Lucene.Net.Analysis.El
len = Rule21(s, len);
}
- return rule22(s, len);
+ return Rule22(s, len);
}
private int Rule0(char[] s, int len)
@@ -974,7 +973,7 @@ namespace Lucene.Net.Analysis.El
return len;
}
- private int rule22(char[] s, int len)
+ private int Rule22(char[] s, int len)
{
if (StemmerUtil.EndsWith(s, len, "\u03b5\u03c3\u03c4\u03b5\u03c1") ||
StemmerUtil.EndsWith(s, len, "\u03b5\u03c3\u03c4\u03b1\u03c4"))
@@ -1022,12 +1021,12 @@ namespace Lucene.Net.Analysis.El
}
/// <summary>
- /// Checks if the word contained in the leading portion of char[] array ,
+ /// Checks if the word contained in the leading portion of <see cref="char[]"/> array ,
/// ends with a Greek vowel.
/// </summary>
- /// <param name="s"> A char[] array that represents a word. </param>
- /// <param name="len"> The length of the char[] array. </param>
- /// <returns> True if the word contained in the leading portion of char[] array ,
+ /// <param name="s"> A <see cref="char[]"/> array that represents a word. </param>
+ /// <param name="len"> The length of the <see cref="char[]"/> array. </param>
+ /// <returns> True if the word contained in the leading portion of <see cref="char[]"/> array ,
/// ends with a vowel , false otherwise. </returns>
private bool EndsWithVowel(char[] s, int len)
{
@@ -1051,12 +1050,12 @@ namespace Lucene.Net.Analysis.El
}
/// <summary>
- /// Checks if the word contained in the leading portion of char[] array ,
+ /// Checks if the word contained in the leading portion of <see cref="char[]"/> array ,
/// ends with a Greek vowel.
/// </summary>
- /// <param name="s"> A char[] array that represents a word. </param>
- /// <param name="len"> The length of the char[] array. </param>
- /// <returns> True if the word contained in the leading portion of char[] array ,
+ /// <param name="s"> A <see cref="char[]"/> array that represents a word. </param>
+ /// <param name="len"> The length of the <see cref="char[]"/> array. </param>
+ /// <returns> True if the word contained in the leading portion of <see cref="char[]"/> array ,
/// ends with a vowel , false otherwise. </returns>
private bool EndsWithVowelNoY(char[] s, int len)
{