lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [13/27] lucenenet git commit: Lucene.Net.Spatial: fix documentation comment formatting problems
Date Sun, 05 Feb 2017 16:51:48 GMT
Lucene.Net.Spatial: fix documentation comment formatting problems


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/c95f6ab9
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/c95f6ab9
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/c95f6ab9

Branch: refs/heads/api-work
Commit: c95f6ab9900eca772062f52785fd84cad5d2955d
Parents: a538f19
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Sun Feb 5 13:31:15 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Sun Feb 5 14:47:54 2017 +0700

----------------------------------------------------------------------
 src/Lucene.Net.Spatial/DisjointSpatialFilter.cs                  | 2 +-
 .../Prefix/AbstractVisitingPrefixTreeFilter.cs                   | 4 ++--
 src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs        | 2 +-
 src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs      | 2 +-
 src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs              | 4 ++--
 src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs          | 2 +-
 src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs          | 4 ++--
 src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs                | 2 +-
 src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs             | 2 +-
 9 files changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/DisjointSpatialFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/DisjointSpatialFilter.cs b/src/Lucene.Net.Spatial/DisjointSpatialFilter.cs
index 18baece..13512c8 100644
--- a/src/Lucene.Net.Spatial/DisjointSpatialFilter.cs
+++ b/src/Lucene.Net.Spatial/DisjointSpatialFilter.cs
@@ -43,7 +43,7 @@ namespace Lucene.Net.Spatial
         /// <param name="args">Used in spatial intersection</param>
         /// <param name="field">
         /// This field is used to determine which docs have spatial data via
-        /// <see cref="FieldCache.GetDocsWithField(AtomicReader, string)"/>.
+        /// <see cref="IFieldCache.GetDocsWithField(AtomicReader, string)"/>.
         /// Passing null will assume all docs have spatial data.
         /// </param>
         public DisjointSpatialFilter(SpatialStrategy strategy, SpatialArgs args, string field)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs b/src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs
index d4a58e9..5d507b9 100644
--- a/src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs
+++ b/src/Lucene.Net.Spatial/Prefix/AbstractVisitingPrefixTreeFilter.cs
@@ -28,7 +28,7 @@ namespace Lucene.Net.Spatial.Prefix
      */
 
     /// <summary>
-    /// Traverses a <see cref="SpatialPrefixTree">SpatialPrefixTree</see> indexed
field, using the template &
+    /// Traverses a <see cref="SpatialPrefixTree">SpatialPrefixTree</see> indexed
field, using the template &amp;
     /// visitor design patterns for subclasses to guide the traversal and collect
     /// matching documents.
     /// <para/>
@@ -299,7 +299,7 @@ namespace Lucene.Net.Spatial.Prefix
             }
 
             /// <summary>
-            /// Called when doing a divide & conquer to find the next intersecting cells
+            /// Called when doing a divide &amp; conquer to find the next intersecting
cells
             /// of the query shape that are beneath <paramref name="cell"/>. <paramref
name="cell"/> is
             /// guaranteed to have an intersection and thus this must return some number
             /// of nodes.

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs b/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs
index bac5e28..7cfa526 100644
--- a/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs
+++ b/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs
@@ -27,7 +27,7 @@ namespace Lucene.Net.Spatial.Prefix
      */
 
     /// <summary>
-    /// Finds docs where its indexed shape <see cref="Queries.SpatialOperation.CONTAINS"/>
+    /// Finds docs where its indexed shape <see cref="Queries.SpatialOperation.Contains"/>
     /// the query shape. For use on <see cref="RecursivePrefixTreeStrategy"/>.
     /// 
     /// @lucene.experimental

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs b/src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs
index 7d54c81..fe449a7 100644
--- a/src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs
+++ b/src/Lucene.Net.Spatial/Prefix/IntersectsPrefixTreeFilter.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Spatial.Prefix
      */
 
     /// <summary>
-    /// A Filter matching documents that have an <see cref="SpatialRelation.Intersects"/>
+    /// A Filter matching documents that have an <see cref="SpatialRelation.INTERSECTS"/>
     /// (i.e. not DISTINCT) relationship with a provided query shape.
     /// 
     /// @lucene.internal

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs b/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs
index 10b6cc0..61ed934 100644
--- a/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs
+++ b/src/Lucene.Net.Spatial/Prefix/PrefixTreeStrategy.cs
@@ -69,7 +69,7 @@ namespace Lucene.Net.Spatial.Prefix
     /// does most of the work, for example returning
     /// a list of terms representing grids of various sizes for a supplied shape.
     /// An important
-    /// configuration item is <see cref="SetDistErrPct(double)"/> which balances
+    /// configuration item is <see cref="DistErrPct"/> which balances
     /// shape precision against scalability.  See those docs.
     /// 
     /// @lucene.internal
@@ -114,7 +114,7 @@ namespace Lucene.Net.Spatial.Prefix
         /// maximum precision (<see cref="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.MaxLevels"/>);
         /// this applies to all other shapes. Specific shapes at index and query time
         /// can use something different than this default value.  If you don't set a
-        /// default then the default is <see cref="SpatialArgs.DefaultDisterrpct"/>
--
+        /// default then the default is <see cref="SpatialArgs.DEFAULT_DISTERRPCT"/>
--
         /// 2.5%.
         /// </remarks>
         /// <seealso cref="Lucene.Net.Spatial.Queries.SpatialArgs.DistErrPct"/>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs b/src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs
index 99f2958..8bf1542 100644
--- a/src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs
+++ b/src/Lucene.Net.Spatial/Prefix/Tree/GeohashPrefixTree.cs
@@ -69,7 +69,7 @@ namespace Lucene.Net.Spatial.Prefix.Tree
             }
         }
 
-        /// <summary>Any more than this and there's no point (double lat & lon
are the same).</summary>
+        /// <summary>Any more than this and there's no point (double lat &amp;
lon are the same).</summary>
         public static int MaxLevelsPossible
         {
             get { return GeohashUtils.MAX_PRECISION; }

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs b/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs
index 4922b6e..b09cb54 100644
--- a/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs
+++ b/src/Lucene.Net.Spatial/Prefix/Tree/SpatialPrefixTree.cs
@@ -172,7 +172,7 @@ namespace Lucene.Net.Spatial.Prefix.Tree
         /// leaf and none of its children are added.
         /// <para/>
         /// This implementation checks if shape is a <see cref="IPoint"/> and if so
returns
-        /// <see cref="GetCells(Point, int, bool)"/>.
+        /// <see cref="GetCells(IPoint, int, bool)"/>.
         /// </remarks>
         /// <param name="shape">the shape; non-null</param>
         /// <param name="detailLevel">the maximum detail level to get cells for</param>
@@ -260,7 +260,7 @@ namespace Lucene.Net.Spatial.Prefix.Tree
 
         /// <summary>
         /// A Point-optimized implementation of
-        /// <see cref="GetCells(Shape, int, bool, bool)"/>. That
+        /// <see cref="GetCells(IShape, int, bool, bool)"/>. That
         /// method in facts calls this for points.
         /// <para/>
         /// This implementation depends on <see cref="GetCell(string)"/> being fast,
as its

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs b/src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs
index 6a1a3d8..6254ab7 100644
--- a/src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs
+++ b/src/Lucene.Net.Spatial/Query/SpatialArgsParser.cs
@@ -29,7 +29,7 @@ namespace Lucene.Net.Spatial.Queries
     /// <summary>
     /// Parses a string that usually looks like "OPERATION(SHAPE)" into a <see cref="SpatialArgs"/>
     /// object. The set of operations supported are defined in <see cref="SpatialOperation"/>,
such
-    /// as "Intersects" being a common one. The shape portion is defined by WKT <see cref="Spatial4n.Core.Io.WktShapeParser"/>,
+    /// as "Intersects" being a common one. The shape portion is defined by WKT <see cref="Spatial4n.Core.IO.WktShapeParser"/>,
     /// but it can be overridden/customized via <see cref="ParseShape(string, SpatialContext)"/>.
     /// There are some optional name-value pair parameters that follow the closing parenthesis.
 Example:
     /// <code>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/c95f6ab9/src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs b/src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs
index b33d346..e8a0e6a 100644
--- a/src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs
+++ b/src/Lucene.Net.Spatial/Vector/PointVectorStrategy.cs
@@ -41,7 +41,7 @@ namespace Lucene.Net.Spatial.Vector
     /// 
     /// <h4>Implementation:</h4>
     /// This is a simple Strategy.  Search works with <see cref="NumericRangeQuery"/>s
on
-    /// an x & y pair of fields.  A Circle query does the same bbox query but adds a
+    /// an x &amp; y pair of fields.  A Circle query does the same bbox query but adds
a
     /// ValueSource filter on <see cref="SpatialStrategy.MakeDistanceValueSource(IPoint)"/>.
     /// <para/>
     /// One performance shortcoming with this strategy is that a scenario involving


Mime
View raw message