You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by bu...@apache.org on 2007/06/17 01:25:38 UTC
svn commit: r547995 -
/lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java
Author: buschmi
Date: Sat Jun 16 16:25:34 2007
New Revision: 547995
URL: http://svn.apache.org/viewvc?view=rev&rev=547995
Log:
LUCENE-910: Change of the Payload javadoc comment in Similarity.java
Modified:
lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java?view=diff&rev=547995&r1=547994&r2=547995
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Similarity.java Sat Jun 16 16:25:34 2007
@@ -513,17 +513,16 @@
* what is in the byte array.
* <p>
* The default implementation returns 1.
+ * <br>
+ * <p><font color="#FF0000">
+ * WARNING: The status of the <b>Payloads</b> feature is experimental.
+ * The APIs introduced here might change in the future and will not be
+ * supported anymore in such a case.</font>
*
* @param payload The payload byte array to be scored
* @param offset The offset into the payload array
* @param length The length in the array
* @return An implementation dependent float to be used as a scoring factor
- * <b>
- * Warning: The status of the Payloads feature is experimental. The APIs
- * introduced here might change in the future and will not be supported anymore
- * in such a case. If you want to use this feature in a production environment
- * you should wait for an official release.
- * </b>
*/
// TODO: Remove warning after API has been finalized
public float scorePayload(byte [] payload, int offset, int length)