lucenenet-commits mailing list archives

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

Branch: refs/heads/api-work
Commit: c2f2f0d57c53092bb2f4478f24adf6670b760ebd
Parents: cdff5aa
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Sat Feb 4 03:07:26 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Sat Feb 4 03:07:26 2017 +0700

----------------------------------------------------------------------
 .../Analysis/Position/PositionFilter.cs              | 15 +++++++--------
 .../Analysis/Position/PositionFilterFactory.cs       |  4 ++--
 2 files changed, 9 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c2f2f0d5/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilter.cs
index 2c1ae97..1b185d5 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilter.cs
@@ -24,16 +24,15 @@ namespace Lucene.Net.Analysis.Position
     /// Set the positionIncrement of all tokens to the "positionIncrement",
     /// except the first return token which retains its original positionIncrement value.
     /// The default positionIncrement value is zero. </summary>
-    /// @deprecated (4.4) PositionFilter makes <see cref="TokenStream"/> graphs inconsistent
+    /// @deprecated (4.4) <see cref="PositionFilter"/> makes <see cref="TokenStream"/>
graphs inconsistent
     ///             which can cause highlighting bugs. Its main use-case being to make
-    ///             <a href="{@docRoot}/../queryparser/overview-summary.html">QueryParser</a>
+    ///             QueryParser
     ///             generate boolean queries instead of phrase queries, it is now advised
to use
-    ///             {@code QueryParser.setAutoGeneratePhraseQueries(boolean)}
-    ///             (for simple cases) or to override {@code QueryParser.newFieldQuery}.

-    [Obsolete("(4.4) PositionFilter makes <seealso cref=\"TokenStream\"/> graphs inconsistent")]
+    ///             <c>QueryParser.AutoGeneratePhraseQueries = true</c>
+    ///             (for simple cases) or to override <c>QueryParser.NewFieldQuery</c>.

+    [Obsolete("(4.4) PositionFilter makes TokenStream graphs inconsistent")]
     public sealed class PositionFilter : TokenFilter
     {
-
         /// <summary>
         /// Position increment to assign to all but the first token - default = 0 </summary>
         private readonly int positionIncrement;
@@ -45,7 +44,7 @@ namespace Lucene.Net.Analysis.Position
         private readonly IPositionIncrementAttribute posIncrAtt;
 
         /// <summary>
-        /// Constructs a PositionFilter that assigns a position increment of zero to
+        /// Constructs a <see cref="PositionFilter"/> that assigns a position increment
of zero to
         /// all but the first token from the given input stream.
         /// </summary>
         /// <param name="input"> the input stream </param>
@@ -55,7 +54,7 @@ namespace Lucene.Net.Analysis.Position
         }
 
         /// <summary>
-        /// Constructs a PositionFilter that assigns the given position increment to
+        /// Constructs a <see cref="PositionFilter"/> that assigns the given position
increment to
         /// all but the first token from the given input stream.
         /// </summary>
         /// <param name="input"> the input stream </param>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c2f2f0d5/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilterFactory.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilterFactory.cs b/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilterFactory.cs
index dfe4d46..f63f813 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilterFactory.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Position/PositionFilterFactory.cs
@@ -34,14 +34,14 @@ namespace Lucene.Net.Analysis.Position
     ///   &lt;/analyzer&gt;
     /// &lt;/fieldType&gt;</code>
     /// </summary>
-    /// <seealso cref=PositionFilter/>
+    /// <seealso cref="PositionFilter"/>
     [Obsolete("(4.4)")]
     public class PositionFilterFactory : TokenFilterFactory
     {
         private readonly int positionIncrement;
 
         /// <summary>
-        /// Creates a new PositionFilterFactory </summary>
+        /// Creates a new <see cref="PositionFilterFactory"/> </summary>
         public PositionFilterFactory(IDictionary<string, string> args)
             : base(args)
         {


Mime
View raw message