lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [13/13] lucenenet git commit: Lucene.Net.Analysis.Fa refactor: member accessibility and documentation comments
Date Fri, 03 Feb 2017 04:42:00 GMT
Lucene.Net.Analysis.Fa 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/20087487
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/20087487
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/20087487

Branch: refs/heads/api-work
Commit: 20087487f3bd05aa588c3775a7852b5ac2af53c2
Parents: 98edabe
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Fri Feb 3 11:40:38 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Fri Feb 3 11:40:38 2017 +0700

----------------------------------------------------------------------
 .../Analysis/Fa/PersianAnalyzer.cs                     | 13 ++++++-------
 .../Analysis/Fa/PersianCharFilter.cs                   |  2 +-
 .../Analysis/Fa/PersianCharFilterFactory.cs            |  6 +++---
 .../Analysis/Fa/PersianNormalizationFilter.cs          |  1 -
 .../Analysis/Fa/PersianNormalizationFilterFactory.cs   |  3 +--
 .../Analysis/Fa/PersianNormalizer.cs                   | 11 +++++------
 6 files changed, 16 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianAnalyzer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianAnalyzer.cs
index 97943be..440c48c 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianAnalyzer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianAnalyzer.cs
@@ -35,12 +35,11 @@ namespace Lucene.Net.Analysis.Fa
     /// </summary>
     public sealed class PersianAnalyzer : StopwordAnalyzerBase
     {
-
         /// <summary>
         /// File containing default Persian stopwords.
         /// 
         /// Default stopword list is from
-        /// http://members.unine.ch/jacques.savoy/clef/index.html The stopword list is
+        /// http://members.unine.ch/jacques.savoy/clef/index.html. The stopword list is
         /// BSD-Licensed.
         /// 
         /// </summary>
@@ -64,7 +63,7 @@ namespace Lucene.Net.Analysis.Fa
         }
 
         /// <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
@@ -89,7 +88,7 @@ namespace Lucene.Net.Analysis.Fa
 
         /// <summary>
         /// Builds an analyzer with the default stop words:
-        /// <see cref="#DEFAULT_STOPWORD_FILE"/>.
+        /// <see cref="DEFAULT_STOPWORD_FILE"/>.
         /// </summary>
         public PersianAnalyzer(LuceneVersion matchVersion)
               : this(matchVersion, DefaultSetHolder.DEFAULT_STOP_SET)
@@ -100,7 +99,7 @@ namespace Lucene.Net.Analysis.Fa
         /// 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 PersianAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords)
@@ -111,7 +110,7 @@ namespace Lucene.Net.Analysis.Fa
         /// <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
@@ -144,7 +143,7 @@ namespace Lucene.Net.Analysis.Fa
         }
 
         /// <summary>
-        /// Wraps the TextReader with <see cref="PersianCharFilter"/>
+        /// Wraps the <see cref="TextReader"/> with <see cref="PersianCharFilter"/>
         /// </summary>
         protected override TextReader InitReader(string fieldName, TextReader reader)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilter.cs
index bea0cde..ef3ac9d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilter.cs
@@ -20,7 +20,7 @@ namespace Lucene.Net.Analysis.Fa
 	 */
 
     /// <summary>
-    /// CharFilter that replaces instances of Zero-width non-joiner with an
+    /// <see cref="CharFilter"/> that replaces instances of Zero-width non-joiner with
an
     /// ordinary space.
     /// </summary>
     public class PersianCharFilter : CharFilter

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilterFactory.cs
index 260b530..af27d94 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianCharFilterFactory.cs
@@ -33,10 +33,10 @@ namespace Lucene.Net.Analysis.Fa
     /// </summary>
     public class PersianCharFilterFactory : CharFilterFactory, IMultiTermAwareComponent
     {
-
         /// <summary>
-        /// Creates a new PersianCharFilterFactory </summary>
-        public PersianCharFilterFactory(IDictionary<string, string> args) : base(args)
+        /// Creates a new <see cref="PersianCharFilterFactory"/> </summary>
+        public PersianCharFilterFactory(IDictionary<string, string> args) 
+            : base(args)
         {
             if (args.Count > 0)
             {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilter.cs
index f3338ab..85baa98 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilter.cs
@@ -22,7 +22,6 @@ namespace Lucene.Net.Analysis.Fa
     /// <summary>
     /// A <see cref="TokenFilter"/> that applies <see cref="PersianNormalizer"/>
to normalize the
     /// orthography.
-    /// 
     /// </summary>
     public sealed class PersianNormalizationFilter : TokenFilter
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilterFactory.cs
b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilterFactory.cs
index be205af..550ed0d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizationFilterFactory.cs
@@ -33,9 +33,8 @@ namespace Lucene.Net.Analysis.Fa
     /// </summary>
     public class PersianNormalizationFilterFactory : TokenFilterFactory, IMultiTermAwareComponent
     {
-
         /// <summary>
-        /// Creates a new PersianNormalizationFilterFactory </summary>
+        /// Creates a new <see cref="PersianNormalizationFilterFactory"/> </summary>
         public PersianNormalizationFilterFactory(IDictionary<string, string> args)
: base(args)
         {
             if (args.Count > 0)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/20087487/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizer.cs b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizer.cs
index 28649e6..81a2cb2 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizer.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Fa/PersianNormalizer.cs
@@ -27,12 +27,11 @@ namespace Lucene.Net.Analysis.Fa
     /// </para>
     /// <para>
     /// Normalization is defined as:
-    /// <ul>
-    /// <li>Normalization of various heh + hamza forms and heh goal to heh.
-    /// <li>Normalization of farsi yeh and yeh barree to arabic yeh
-    /// <li>Normalization of persian keheh to arabic kaf
-    /// </ul>
-    /// 
+    /// <list type="bullet">
+    ///     <item>Normalization of various heh + hamza forms and heh goal to heh.</item>
+    ///     <item>Normalization of farsi yeh and yeh barree to arabic yeh</item>
+    ///     <item>Normalization of persian keheh to arabic kaf</item>
+    /// </list>
     /// </para>
     /// </summary>
     public class PersianNormalizer


Mime
View raw message