svn commit: r699549 - in /lucene/solr/trunk: CHANGES.txt src/java/org/apache/solr/schema/RandomSortField.java

[ko...@apache.org]

Author: koji
Date: Fri Sep 26 20:45:40 2008
New Revision: 699549

URL: http://svn.apache.org/viewvc?rev=699549&view=rev
Log:
SOLR-789: The javadoc of RandomSortField is not readable

Modified:
    lucene/solr/trunk/CHANGES.txt
    lucene/solr/trunk/src/java/org/apache/solr/schema/RandomSortField.java

Modified: lucene/solr/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/CHANGES.txt?rev=699549&r1=699548&r2=699549&view=diff
==============================================================================
--- lucene/solr/trunk/CHANGES.txt (original)
+++ lucene/solr/trunk/CHANGES.txt Fri Sep 26 20:45:40 2008
@@ -57,7 +57,7 @@
 
 Documentation
 ----------------------
-
+ 1. SOLR-789: The javadoc of RandomSortField is not readable (Nicolas Lalevée via koji)
 
 
 

Modified: lucene/solr/trunk/src/java/org/apache/solr/schema/RandomSortField.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/schema/RandomSortField.java?rev=699549&r1=699548&r2=699549&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/schema/RandomSortField.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/schema/RandomSortField.java Fri Sep 26 20:45:40 2008
@@ -32,27 +32,30 @@
 
 /**
  * Utility Field used for random sorting.  It should not be passed a value.
- * 
+ * <p>
  * This random sorting implementation uses the dynamic field name to set the
  * random 'seed'.  To get random sorting order, you need to use a random
  * dynamic field name.  For example, you will need to configure schema.xml:
- * 
- * <types>
+ * <pre>
+ * &lt;types&gt;
  *  ...
- *  <fieldType name="random" class="solr.RandomSortField" />
+ *  &lt;fieldType name="random" class="solr.RandomSortField" /&gt;
  *  ... 
- * </types>
- * <fields>
+ * &lt;/types&gt;
+ * &lt;fields&gt;
  *  ...
- *  <dynamicField name="random*" type="rand" indexed="true" stored="false"/>
+ *  &lt;dynamicField name="random*" type="rand" indexed="true" stored="false"/&gt;
  *  ...
- * </fields>
+ * &lt;/fields&gt;
+ * </pre>
  * 
- *  http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_1234%20desc
- *  http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_2345%20desc
- *  http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_ABDC%20desc
- *  http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_21%20desc
- *  
+ * Examples of queries:
+ * <ul>
+ * <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_1234%20desc</li>
+ * <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_2345%20desc</li>
+ * <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_ABDC%20desc</li>
+ * <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_21%20desc</li>
+ * </ul>
  * Note that multiple calls to the same URL will return the same sorting order.
  * 
  * @version $Id$