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/02 14:54:57 UTC

[2/6] lucenenet git commit: Lucene.Net.Analysis.Bg refactor: member accessibility and documentation comments

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

Branch: refs/heads/api-work
Commit: 1b0bca68b88838741866ad7ab782206ccb66518b
Parents: 2878664
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Thu Feb 2 20:16:24 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Thu Feb 2 20:16:24 2017 +0700

----------------------------------------------------------------------
 .../Analysis/Bg/BulgarianAnalyzer.cs            | 24 +++++++++-----------
 .../Analysis/Bg/BulgarianStemFilter.cs          |  6 ++---
 .../Analysis/Bg/BulgarianStemFilterFactory.cs   |  9 ++++----
 .../Analysis/Bg/BulgarianStemmer.cs             |  4 ++--
 4 files changed, 21 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b0bca68/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianAnalyzer.cs
index efa9eca..cab90fa 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianAnalyzer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianAnalyzer.cs
@@ -26,14 +26,12 @@ namespace Lucene.Net.Analysis.Bg
 	 */
 
     /// <summary>
-    /// <seealso cref="Analyzer"/> for Bulgarian.
+    /// <see cref="Analyzer"/> for Bulgarian.
     /// <para>
     /// This analyzer implements light-stemming as specified by: <i> Searching
     /// Strategies for the Bulgarian Language </i>
     /// http://members.unine.ch/jacques.savoy/Papers/BUIR.pdf
     /// </para>
-    /// <para>
-    /// </para>
     /// </summary>
     public sealed class BulgarianAnalyzer : StopwordAnalyzerBase
     {
@@ -86,7 +84,7 @@ namespace Lucene.Net.Analysis.Bg
 
         /// <summary>
         /// Builds an analyzer with the default stop words:
-        /// <seealso cref="#DEFAULT_STOPWORD_FILE"/>.
+        /// <see cref="DEFAULT_STOPWORD_FILE"/>.
         /// </summary>
         public BulgarianAnalyzer(LuceneVersion matchVersion)
               : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET)
@@ -103,8 +101,8 @@ namespace Lucene.Net.Analysis.Bg
 
         /// <summary>
         /// Builds an analyzer with the given stop words and a stem exclusion set.
-        /// If a stem exclusion set is provided this analyzer will add a <seealso cref="SetKeywordMarkerFilter"/> 
-        /// before <seealso cref="BulgarianStemFilter"/>.
+        /// If a stem exclusion set is provided this analyzer will add a <see cref="SetKeywordMarkerFilter"/> 
+        /// before <see cref="BulgarianStemFilter"/>.
         /// </summary>
         public BulgarianAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords, CharArraySet stemExclusionSet)
               : base(matchVersion, stopwords)
@@ -114,15 +112,15 @@ namespace Lucene.Net.Analysis.Bg
 
         /// <summary>
         /// Creates a
-        /// <seealso cref="org.apache.lucene.analysis.Analyzer.TokenStreamComponents"/>
-        /// which tokenizes all the text in the provided <seealso cref="Reader"/>.
+        /// <see cref="Analyzer.TokenStreamComponents"/>
+        /// which tokenizes all the text in the provided <see cref="TextReader"/>.
         /// </summary>
         /// <returns> A
-        ///         <seealso cref="org.apache.lucene.analysis.Analyzer.TokenStreamComponents"/>
-        ///         built from an <seealso cref="StandardTokenizer"/> filtered with
-        ///         <seealso cref="StandardFilter"/>, <seealso cref="LowerCaseFilter"/>, <seealso cref="StopFilter"/>
-        ///         , <seealso cref="SetKeywordMarkerFilter"/> if a stem exclusion set is
-        ///         provided and <seealso cref="BulgarianStemFilter"/>. </returns>
+        ///         <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
+        ///         provided and <see cref="BulgarianStemFilter"/>. </returns>
         protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
         {
             Tokenizer source = new StandardTokenizer(m_matchVersion, reader);

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b0bca68/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilter.cs
index 42dff08..beeef3b 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilter.cs
@@ -20,12 +20,12 @@ namespace Lucene.Net.Analysis.Bg
 	 */
 
     /// <summary>
-    /// A <seealso cref="TokenFilter"/> that applies <seealso cref="BulgarianStemmer"/> to stem Bulgarian
+    /// A <see cref="TokenFilter"/> that applies <see cref="BulgarianStemmer"/> to stem Bulgarian
     /// words.
     /// <para>
     /// To prevent terms from being stemmed use an instance of
-    /// <seealso cref="SetKeywordMarkerFilter"/> or a custom <seealso cref="TokenFilter"/> that sets
-    /// the <seealso cref="KeywordAttribute"/> before this <seealso cref="TokenStream"/>.
+    /// <see cref="Miscellaneous.SetKeywordMarkerFilter"/> or a custom <see cref="TokenFilter"/> that sets
+    /// the <see cref="KeywordAttribute"/> before this <see cref="TokenStream"/>.
     /// </para>
     /// </summary>
     public sealed class BulgarianStemFilter : TokenFilter

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b0bca68/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilterFactory.cs
index 1ba70d9..ab47af6 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemFilterFactory.cs
@@ -21,21 +21,22 @@ namespace Lucene.Net.Analysis.Bg
 	 */
 
     /// <summary>
-    /// Factory for <seealso cref="BulgarianStemFilter"/>.
-    /// <pre class="prettyprint">
+    /// Factory for <see cref="BulgarianStemFilter"/>.
+    /// <code>
     /// &lt;fieldType name="text_bgstem" class="solr.TextField" positionIncrementGap="100"&gt;
     ///   &lt;analyzer&gt;
     ///     &lt;tokenizer class="solr.StandardTokenizerFactory"/&gt;
     ///     &lt;filter class="solr.LowerCaseFilterFactory"/&gt;
     ///     &lt;filter class="solr.BulgarianStemFilterFactory"/&gt;
     ///   &lt;/analyzer&gt;
-    /// &lt;/fieldType&gt;</pre>
+    /// &lt;/fieldType&gt;
+    /// </code>
     /// </summary>
     public class BulgarianStemFilterFactory : TokenFilterFactory
     {
 
         /// <summary>
-        /// Creates a new BulgarianStemFilterFactory </summary>
+        /// Creates a new <see cref="BulgarianStemFilterFactory"/> </summary>
         public BulgarianStemFilterFactory(IDictionary<string, string> args)
               : base(args)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1b0bca68/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemmer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemmer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemmer.cs
index 0b8c339..3ff4017 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemmer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Bg/BulgarianStemmer.cs
@@ -23,9 +23,9 @@ namespace Lucene.Net.Analysis.Bg
     /// Light Stemmer for Bulgarian.
     /// <para>
     /// Implements the algorithm described in:  
-    /// <i>
+    /// <c>
     /// Searching Strategies for the Bulgarian Language
-    /// </i>
+    /// </c>
     /// http://members.unine.ch/jacques.savoy/Papers/BUIR.pdf
     /// </para>
     /// </summary>