Lucene.Net.Analysis.Fr 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/3dfc567f Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/3dfc567f Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/3dfc567f Branch: refs/heads/api-work Commit: 3dfc567fe20a43fdbbdc7eccd8043b986e5a9c3b Parents: f3eafac Author: Shad Storhaug <[email protected]> Authored: Fri Feb 3 15:07:47 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Fri Feb 3 15:07:47 2017 +0700 ---------------------------------------------------------------------- .../Analysis/Fr/FrenchAnalyzer.cs | 54 ++++++--- .../Analysis/Fr/FrenchLightStemFilter.cs | 2 +- .../Analysis/Fr/FrenchLightStemFilterFactory.cs | 3 +- .../Analysis/Fr/FrenchLightStemmer.cs | 3 +- .../Analysis/Fr/FrenchMinimalStemFilter.cs | 2 +- .../Fr/FrenchMinimalStemFilterFactory.cs | 3 +- .../Analysis/Fr/FrenchMinimalStemmer.cs | 2 +- .../Analysis/Fr/FrenchStemFilter.cs | 9 +- .../Analysis/Fr/FrenchStemmer.cs | 118 +++++++++---------- 9 files changed, 105 insertions(+), 91 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchAnalyzer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchAnalyzer.cs index b9c01d2..5a910fe 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchAnalyzer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchAnalyzer.cs @@ -37,18 +37,16 @@ namespace Lucene.Net.Analysis.Fr /// A default set of stopwords is used unless an alternative list is specified, but the /// exclusion list is empty by default. /// </para> - /// - /// <a name="version"/> /// <para>You must specify the required <see cref="LuceneVersion"/> /// compatibility when creating FrenchAnalyzer: - /// <ul> - /// <li> As of 3.6, FrenchLightStemFilter is used for less aggressive stemming. - /// <li> As of 3.1, Snowball stemming is done with SnowballFilter, - /// LowerCaseFilter is used prior to StopFilter, and ElisionFilter and - /// Snowball stopwords are used by default. - /// <li> As of 2.9, StopFilter preserves position - /// increments - /// </ul> + /// <list type="bullet"> + /// <item> As of 3.6, <see cref="FrenchLightStemFilter"/> is used for less aggressive stemming.</item> + /// <item> As of 3.1, Snowball stemming is done with <see cref="SnowballFilter"/>, + /// <see cref="LowerCaseFilter"/> is used prior to <see cref="StopFilter"/>, and <see cref="ElisionFilter"/> and + /// Snowball stopwords are used by default.</item> + /// <item> As of 2.9, <see cref="StopFilter"/> preserves position + /// increments</item> + /// </list> /// /// </para> /// <para><b>NOTE</b>: This class uses the same <see cref="LuceneVersion"/> @@ -56,19 +54,41 @@ namespace Lucene.Net.Analysis.Fr /// </summary> public sealed class FrenchAnalyzer : StopwordAnalyzerBase { - /// <summary> /// Extended list of typical French stopwords. </summary> /// @deprecated (3.1) remove in Lucene 5.0 (index bw compat) [Obsolete("(3.1) remove in Lucene 5.0 (index bw compat)")] - private static readonly string[] FRENCH_STOP_WORDS = new string[] { "a", "afin", "ai", "ainsi", "après", "attendu", "au", "aujourd", "auquel", "aussi", "autre", "autres", "aux", "auxquelles", "auxquels", "avait", "avant", "avec", "avoir", "c", "car", "ce", "ceci", "cela", "celle", "celles", "celui", "cependant", "certain", "certaine", "certaines", "certains", "ces", "cet", "cette", "ceux", "chez", "ci", "combien", "comme", "comment", "concernant", "contre", "d", "dans", "de", "debout", "dedans", "dehors", "delà ", "depuis", "derrière", "des", "désormais", "desquelles", "desquels", "dessous", "dessus", "devant", "devers", "devra", "divers", "diverse", "diverses", "doit", "donc", "dont", "du", "duquel", "durant", "dès", "elle", "elles", "en", "entre", "environ", "est", "et", "etc", "etre", "eu", "eux", "excepté", "hormis", "hors", "hélas", "hui", "il", "ils", "j", "je", "jusqu", "jusque", "l", "la", "laquelle", "le", "lequel", "les", "lesquelles", "lesquels", "leur", "le urs", "lorsque", "lui", "là ", "ma", "mais", "malgré", "me", "merci", "mes", "mien", "mienne", "miennes", "miens", "moi", "moins", "mon", "moyennant", "même", "mêmes", "n", "ne", "ni", "non", "nos", "notre", "nous", "néanmoins", "nôtre", "nôtres", "on", "ont", "ou", "outre", "où", "par", "parmi", "partant", "pas", "passé", "pendant", "plein", "plus", "plusieurs", "pour", "pourquoi", "proche", "près", "puisque", "qu", "quand", "que", "quel", "quelle", "quelles", "quels", "qui", "quoi", "quoique", "revoici", "revoilà ", "s", "sa", "sans", "sauf", "se", "selon", "seront", "ses", "si", "sien", "sienne", "siennes", "siens", "sinon", "soi", "soit", "son", "sont", "sous", "suivant", "sur", "ta", "te", "tes", "tien", "tienne", "tiennes", "tiens", "toi", "ton", "tous", "tout", "toute", "toutes", "tu", "un", "une", "va", "vers", "voici", "voilà ", "vos", "votre", "vous", "vu", "vôtre", "vôtres", "y", "à ", "ça", "ès", "été", "être", "ô" }; + private static readonly string[] FRENCH_STOP_WORDS = new string[] { + "a", "afin", "ai", "ainsi", "après", "attendu", "au", "aujourd", "auquel", "aussi", + "autre", "autres", "aux", "auxquelles", "auxquels", "avait", "avant", "avec", "avoir", + "c", "car", "ce", "ceci", "cela", "celle", "celles", "celui", "cependant", "certain", + "certaine", "certaines", "certains", "ces", "cet", "cette", "ceux", "chez", "ci", + "combien", "comme", "comment", "concernant", "contre", "d", "dans", "de", "debout", + "dedans", "dehors", "delà ", "depuis", "derrière", "des", "désormais", "desquelles", + "desquels", "dessous", "dessus", "devant", "devers", "devra", "divers", "diverse", + "diverses", "doit", "donc", "dont", "du", "duquel", "durant", "dès", "elle", "elles", + "en", "entre", "environ", "est", "et", "etc", "etre", "eu", "eux", "excepté", "hormis", + "hors", "hélas", "hui", "il", "ils", "j", "je", "jusqu", "jusque", "l", "la", "laquelle", + "le", "lequel", "les", "lesquelles", "lesquels", "leur", "leurs", "lorsque", "lui", "là ", + "ma", "mais", "malgré", "me", "merci", "mes", "mien", "mienne", "miennes", "miens", "moi", + "moins", "mon", "moyennant", "même", "mêmes", "n", "ne", "ni", "non", "nos", "notre", + "nous", "néanmoins", "nôtre", "nôtres", "on", "ont", "ou", "outre", "où", "par", "parmi", + "partant", "pas", "passé", "pendant", "plein", "plus", "plusieurs", "pour", "pourquoi", + "proche", "près", "puisque", "qu", "quand", "que", "quel", "quelle", "quelles", "quels", + "qui", "quoi", "quoique", "revoici", "revoilà ", "s", "sa", "sans", "sauf", "se", "selon", + "seront", "ses", "si", "sien", "sienne", "siennes", "siens", "sinon", "soi", "soit", + "son", "sont", "sous", "suivant", "sur", "ta", "te", "tes", "tien", "tienne", "tiennes", + "tiens", "toi", "ton", "tous", "tout", "toute", "toutes", "tu", "un", "une", "va", "vers", + "voici", "voilà ", "vos", "votre", "vous", "vu", "vôtre", "vôtres", "y", "à ", "ça", "ès", + "été", "être", "ô" + }; /// <summary> /// File containing default French stopwords. </summary> public const string DEFAULT_STOPWORD_FILE = "french_stop.txt"; /// <summary> - /// Default set of articles for ElisionFilter </summary> + /// Default set of articles for <see cref="ElisionFilter"/> </summary> public static readonly CharArraySet DEFAULT_ARTICLES = CharArraySet.UnmodifiableSet(new CharArraySet( #pragma warning disable 612, 618 LuceneVersion.LUCENE_CURRENT, @@ -118,7 +138,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Builds an analyzer with the default stop words (<see cref="#getDefaultStopSet"/>). + /// Builds an analyzer with the default stop words (<see cref="DefaultStopSet"/>). /// </summary> public FrenchAnalyzer(LuceneVersion matchVersion) #pragma warning disable 612, 618 @@ -132,7 +152,7 @@ namespace Lucene.Net.Analysis.Fr /// Builds an analyzer with the given stop words /// </summary> /// <param name="matchVersion"> - /// lucene compatibility version </param> + /// <see cref="LuceneVersion"/> lucene compatibility version </param> /// <param name="stopwords"> /// a stopword set </param> public FrenchAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords) @@ -144,7 +164,7 @@ namespace Lucene.Net.Analysis.Fr /// Builds an analyzer with the given stop words /// </summary> /// <param name="matchVersion"> - /// lucene compatibility version </param> + /// <see cref="LuceneVersion"/> lucene compatibility version </param> /// <param name="stopwords"> /// a stopword set </param> /// <param name="stemExclutionSet"> @@ -158,7 +178,7 @@ namespace Lucene.Net.Analysis.Fr /// <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/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilter.cs index cd97757..0d30f9d 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilter.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilter.cs @@ -24,7 +24,7 @@ namespace Lucene.Net.Analysis.Fr /// 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/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilterFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilterFactory.cs index 548489b..c56aeec 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilterFactory.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemFilterFactory.cs @@ -34,9 +34,8 @@ namespace Lucene.Net.Analysis.Fr /// </summary> public class FrenchLightStemFilterFactory : TokenFilterFactory { - /// <summary> - /// Creates a new FrenchLightStemFilterFactory </summary> + /// Creates a new <see cref="FrenchLightStemFilterFactory"/> </summary> public FrenchLightStemFilterFactory(IDictionary<string, string> args) : base(args) { if (args.Count > 0) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemmer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemmer.cs index 865ac8d..e7e1b79 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemmer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchLightStemmer.cs @@ -58,13 +58,12 @@ namespace Lucene.Net.Analysis.Fr /// Light Stemmer for French. /// <para> /// This stemmer implements the "UniNE" algorithm in: - /// <i>Light Stemming Approaches for the French, Portuguese, German and Hungarian Languages</i> + /// <c>Light Stemming Approaches for the French, Portuguese, German and Hungarian Languages</c> /// Jacques Savoy /// </para> /// </summary> public class FrenchLightStemmer { - public virtual int Stem(char[] s, int len) { if (len > 5 && s[len - 1] == 'x') http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilter.cs index 2cdf579..b71cfc1 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilter.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilter.cs @@ -24,7 +24,7 @@ namespace Lucene.Net.Analysis.Fr /// 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/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilterFactory.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilterFactory.cs index ef587d9..95694da 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilterFactory.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemFilterFactory.cs @@ -33,9 +33,8 @@ namespace Lucene.Net.Analysis.Fr /// </summary> public class FrenchMinimalStemFilterFactory : TokenFilterFactory { - /// <summary> - /// Creates a new FrenchMinimalStemFilterFactory </summary> + /// Creates a new <see cref="FrenchMinimalStemFilterFactory"/> </summary> public FrenchMinimalStemFilterFactory(IDictionary<string, string> args) : base(args) { if (args.Count > 0) http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemmer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemmer.cs index 973d3c5..39701d3 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemmer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchMinimalStemmer.cs @@ -56,7 +56,7 @@ /// Light Stemmer for French. /// <para> /// This stemmer implements the following algorithm: - /// <i>A Stemming procedure and stopword list for general French corpora.</i> + /// <c>A Stemming procedure and stopword list for general French corpora.</c> /// Jacques Savoy. /// </para> /// </summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemFilter.cs index f74b10a..b14365b 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemFilter.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemFilter.cs @@ -28,17 +28,16 @@ namespace Lucene.Net.Analysis.Fr /// </para> /// <para> /// To prevent terms from being stemmed use an instance of - /// <see cref="KeywordMarkerFilter"/> or a custom <see cref="TokenFilter"/> that sets + /// <see cref="Miscellaneous.KeywordMarkerFilter"/> or a custom <see cref="TokenFilter"/> that sets /// the <see cref="KeywordAttribute"/> before this <see cref="TokenStream"/>. /// </para> </summary> - /// <seealso cref= KeywordMarkerFilter </seealso> - /// @deprecated (3.1) Use <see cref="SnowballFilter"/> with - /// <see cref="org.tartarus.snowball.ext.FrenchStemmer"/> instead, which has the + /// <seealso cref="Miscellaneous.KeywordMarkerFilter"/> + /// @deprecated (3.1) Use <see cref="Snowball.SnowballFilter"/> with + /// <see cref="Tartarus.Snowball.Ext.FrenchStemmer"/> instead, which has the /// same functionality. This filter will be removed in Lucene 5.0 [Obsolete("(3.1) Use SnowballFilter with FrenchStemmer instead, which has the same functionality. This filter will be removed in Lucene 5.0")] public sealed class FrenchStemFilter : TokenFilter { - /// <summary> /// The actual token in the input stream. /// </summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/3dfc567f/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemmer.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemmer.cs index ce3cc41..e67a7fb 100644 --- a/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemmer.cs +++ b/src/Lucene.Net.Analysis.Common/Analysis/Fr/FrenchStemmer.cs @@ -23,20 +23,19 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// A stemmer for French words. - /// <para> + /// <para/> /// The algorithm is based on the work of - /// Dr Martin Porter on his snowball project<br> - /// refer to http://snowball.sourceforge.net/french/stemmer.html<br> + /// Dr Martin Porter on his snowball project<para/> + /// refer to http://snowball.sourceforge.net/french/stemmer.html /// (French stemming algorithm) for details - /// </para> </summary> - /// @deprecated Use <see cref="org.tartarus.snowball.ext.FrenchStemmer"/> instead, - /// which has the same functionality. This filter will be removed in Lucene 4.0 + /// </summary> + /// @deprecated Use <see cref="Tartarus.Snowball.Ext.FrenchStemmer"/> instead, + /// which has the same functionality. This filter will be removed in Lucene 4.0 [Obsolete("Use FrenchStemmer instead, which has the same functionality.")] public class FrenchStemmer { private static readonly CultureInfo locale = new CultureInfo("fr-FR"); - /// <summary> /// Buffer for the terms while stemming them. /// </summary> @@ -87,10 +86,10 @@ namespace Lucene.Net.Analysis.Fr /// <summary> - /// Stems the given term to a unique <tt>discriminator</tt>. + /// Stems the given term to a unique <c>discriminator</c>. /// </summary> - /// <param name="term"> java.langString The term that should be stemmed </param> - /// <returns> java.lang.String Discriminator for <tt>term</tt> </returns> + /// <param name="term"> The term that should be stemmed </param> + /// <returns> Discriminator for <paramref name="term"/> </returns> protected internal virtual string Stem(string term) { if (!IsStemmable(term)) @@ -144,7 +143,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Sets the search region Strings<br> + /// Sets the search region strings /// it needs to be done each time the buffer was modified /// </summary> private void SetStrings() @@ -166,7 +165,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// First step of the Porter Algorithm<br> + /// First step of the Porter Algorithm<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step1() @@ -227,12 +226,12 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Second step (A) of the Porter Algorithm<br> + /// Second step (A) of the Porter Algorithm<para/> /// Will be performed if nothing changed from the first step - /// or changed were done in the amment, emment, ments or ment suffixes<br> + /// or changed were done in the amment, emment, ments or ment suffixes<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> - /// <returns> boolean - true if something changed in the StringBuilder </returns> + /// <returns> true if something changed in the <see cref="StringBuilder"/> </returns> private bool Step2a() { string[] search = new string[] { "îmes", "îtes", "iraIent", "irait", "irais", "irai", "iras", "ira", "irent", "iriez", "irez", "irions", "irons", "iront", "issaIent", "issais", "issantes", "issante", "issants", "issant", "issait", "issais", "issions", "issons", "issiez", "issez", "issent", "isses", "isse", "ir", "is", "ît", "it", "ies", "ie", "i" }; @@ -240,8 +239,8 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Second step (B) of the Porter Algorithm<br> - /// Will be performed if step 2 A was performed unsuccessfully<br> + /// Second step (B) of the Porter Algorithm<para/> + /// Will be performed if step 2 A was performed unsuccessfully<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step2b() @@ -256,7 +255,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Third step of the Porter Algorithm<br> + /// Third step of the Porter Algorithm<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step3() @@ -278,7 +277,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Fourth step of the Porter Algorithm<br> + /// Fourth step of the Porter Algorithm<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step4() @@ -308,7 +307,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Fifth step of the Porter Algorithm<br> + /// Fifth step of the Porter Algorithm<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step5() @@ -324,7 +323,7 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Sixth (and last!) step of the Porter Algorithm<br> + /// Sixth (and last!) step of the Porter Algorithm<para/> /// refer to http://snowball.sourceforge.net/french/stemmer.html for an explanation /// </summary> private void Step6() @@ -371,11 +370,11 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// Delete a suffix searched in zone "source" if zone "from" contains prefix + search string /// </summary> - /// <param name="source"> java.lang.String - the primary source zone for search </param> - /// <param name="search"> java.lang.String[] - the strings to search for suppression </param> - /// <param name="from"> java.lang.String - the secondary source zone for search </param> - /// <param name="prefix"> java.lang.String - the prefix to add to the search string to test </param> - /// <returns> boolean - true if modified </returns> + /// <param name="source"> the primary source zone for search </param> + /// <param name="search"> the strings to search for suppression </param> + /// <param name="from"> the secondary source zone for search </param> + /// <param name="prefix"> the prefix to add to the search string to test </param> + /// <returns> true if modified </returns> private bool DeleteFromIfPrecededIn(string source, string[] search, string from, string prefix) { bool found = false; @@ -401,11 +400,11 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// Delete a suffix searched in zone "source" if the preceding letter is (or isn't) a vowel /// </summary> - /// <param name="source"> java.lang.String - the primary source zone for search </param> - /// <param name="search"> java.lang.String[] - the strings to search for suppression </param> - /// <param name="vowel"> boolean - true if we need a vowel before the search string </param> - /// <param name="from"> java.lang.String - the secondary source zone for search (where vowel could be) </param> - /// <returns> boolean - true if modified </returns> + /// <param name="source"> the primary source zone for search </param> + /// <param name="search"> the strings to search for suppression </param> + /// <param name="vowel"> true if we need a vowel before the search string </param> + /// <param name="from"> the secondary source zone for search (where vowel could be) </param> + /// <returns> true if modified </returns> private bool DeleteFromIfTestVowelBeforeIn(string source, string[] search, bool vowel, string from) { bool found = false; @@ -436,10 +435,10 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// Delete a suffix searched in zone "source" if preceded by the prefix /// </summary> - /// <param name="source"> java.lang.String - the primary source zone for search </param> - /// <param name="search"> java.lang.String[] - the strings to search for suppression </param> - /// <param name="prefix"> java.lang.String - the prefix to add to the search string to test </param> - /// <param name="without"> boolean - true if it will be deleted even without prefix found </param> + /// <param name="source"> the primary source zone for search </param> + /// <param name="search"> the strings to search for suppression </param> + /// <param name="prefix"> the prefix to add to the search string to test </param> + /// <param name="without"> true if it will be deleted even without prefix found </param> private void DeleteButSuffixFrom(string source, string[] search, string prefix, bool without) { if (source != null) @@ -465,14 +464,14 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Delete a suffix searched in zone "source" if preceded by prefix<br> - /// or replace it with the replace string if preceded by the prefix in the zone "from"<br> + /// Delete a suffix searched in zone "source" if preceded by prefix<para/> + /// or replace it with the replace string if preceded by the prefix in the zone "from"<para/> /// or delete the suffix if specified /// </summary> - /// <param name="source"> java.lang.String - the primary source zone for search </param> - /// <param name="search"> java.lang.String[] - the strings to search for suppression </param> - /// <param name="prefix"> java.lang.String - the prefix to add to the search string to test </param> - /// <param name="without"> boolean - true if it will be deleted even without prefix found </param> + /// <param name="source"> the primary source zone for search </param> + /// <param name="search"> the strings to search for suppression </param> + /// <param name="prefix"> the prefix to add to the search string to test </param> + /// <param name="without"> true if it will be deleted even without prefix found </param> private void DeleteButSuffixFromElseReplace(string source, string[] search, string prefix, bool without, string from, string replace) { if (source != null) @@ -507,9 +506,9 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// Replace a search string with another within the source zone /// </summary> - /// <param name="source"> java.lang.String - the source zone for search </param> - /// <param name="search"> java.lang.String[] - the strings to search for replacement </param> - /// <param name="replace"> java.lang.String - the replacement string </param> + /// <param name="source"> the source zone for search </param> + /// <param name="search"> the strings to search for replacement </param> + /// <param name="replace"> the replacement string </param> private bool ReplaceFrom(string source, string[] search, string replace) { bool found = false; @@ -556,7 +555,7 @@ namespace Lucene.Net.Analysis.Fr /// Test if a char is a french vowel, including accentuated ones /// </summary> /// <param name="ch"> the char to test </param> - /// <returns> boolean - true if the char is a vowel </returns> + /// <returns> true if the char is a vowel </returns> private bool IsVowel(char ch) { switch (ch) @@ -586,11 +585,11 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Retrieve the "R zone" (1 or 2 depending on the buffer) and return the corresponding string<br> + /// Retrieve the "R zone" (1 or 2 depending on the buffer) and return the corresponding string<para/> /// "R is the region after the first non-vowel following a vowel - /// or is the null region at the end of the word if there is no such non-vowel"<br> </summary> - /// <param name="buffer"> java.lang.StringBuilder - the in buffer </param> - /// <returns> java.lang.String - the resulting string </returns> + /// or is the null region at the end of the word if there is no such non-vowel" </summary> + /// <param name="buffer"> the in buffer </param> + /// <returns> the resulting string </returns> private string RetrieveR(StringBuilder buffer) { int len = buffer.Length; @@ -631,12 +630,12 @@ namespace Lucene.Net.Analysis.Fr } /// <summary> - /// Retrieve the "RV zone" from a buffer an return the corresponding string<br> + /// Retrieve the "RV zone" from a buffer an return the corresponding string<para/> /// "If the word begins with two vowels, RV is the region after the third letter, /// otherwise the region after the first vowel not at the beginning of the word, - /// or the end of the word if these positions cannot be found."<br> </summary> - /// <param name="buffer"> java.lang.StringBuilder - the in buffer </param> - /// <returns> java.lang.String - the resulting string </returns> + /// or the end of the word if these positions cannot be found." </summary> + /// <param name="buffer"> the in buffer </param> + /// <returns> the resulting string </returns> private string RetrieveRV(StringBuilder buffer) { int len = buffer.Length; @@ -660,7 +659,6 @@ namespace Lucene.Net.Analysis.Fr if (pos + 1 < len) { return buffer.ToString(pos + 1, len - (pos + 1)); - //return StringHelperClass.SubstringSpecial(buffer, pos + 1, len); } else { @@ -677,12 +675,12 @@ namespace Lucene.Net.Analysis.Fr /// <summary> - /// Turns u and i preceded AND followed by a vowel to UpperCase<br> - /// Turns y preceded OR followed by a vowel to UpperCase<br> - /// Turns u preceded by q to UpperCase<br> + /// Turns u and i preceded AND followed by a vowel to UpperCase<para/> + /// Turns y preceded OR followed by a vowel to UpperCase<para/> + /// Turns u preceded by q to UpperCase /// </summary> - /// <param name="buffer"> java.util.StringBuilder - the buffer to treat </param> - /// <returns> java.util.StringBuilder - the treated buffer </returns> + /// <param name="buffer"> the buffer to treat </param> + /// <returns> the treated buffer </returns> private StringBuilder TreatVowels(StringBuilder buffer) { for (int c = 0; c < buffer.Length; c++) @@ -746,7 +744,7 @@ namespace Lucene.Net.Analysis.Fr /// <summary> /// Checks a term if it can be processed correctly. /// </summary> - /// <returns> boolean - true if, and only if, the given term consists in letters. </returns> + /// <returns> true if, and only if, the given term consists in letters. </returns> private bool IsStemmable(string term) { bool upper = false;
