svn commit: r881090 - /lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java

[gs...@apache.org]

Author: gsingers
Date: Tue Nov 17 01:53:47 2009
New Revision: 881090

URL: http://svn.apache.org/viewvc?rev=881090&view=rev
Log:
SOLR-1302: javadocs

Modified:
    lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java

Modified: lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java?rev=881090&r1=881089&r2=881090&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/search/function/distance/DistanceUtils.java Tue Nov 17 01:53:47 2009
@@ -25,12 +25,12 @@
   /**
    * @see org.apache.solr.search.function.distance.HaversineFunction
    * 
-   * @param x1
-   * @param y1
-   * @param x2
-   * @param y2
-   * @param radius
-   * @return
+   * @param x1 The x coordinate of the first point
+   * @param y1 The y coordinate of the first point
+   * @param x2 The x coordinate of the second point
+   * @param y2 The y coordinate of the second point
+   * @param radius The radius of the sphere
+   * @return The distance between the two points, as determined by the Haversine formula.
    */
   public static double haversine(double x1, double y1, double x2, double y2, double radius){
     double result = 0;