Author: hardy.ferentschik
Date: 2008-12-02 09:21:37 -0500 (Tue, 02 Dec 2008)
New Revision: 15636
Modified:
search/trunk/src/java/org/hibernate/search/annotations/Indexed.java
search/trunk/src/java/org/hibernate/search/store/DirectoryProviderFactory.java
search/trunk/src/java/org/hibernate/search/store/FSDirectoryProvider.java
Log:
Javadoc changes
Modified: search/trunk/src/java/org/hibernate/search/annotations/Indexed.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/Indexed.java 2008-12-02
14:18:09 UTC (rev 15635)
+++ search/trunk/src/java/org/hibernate/search/annotations/Indexed.java 2008-12-02
14:21:37 UTC (rev 15636)
@@ -15,7 +15,7 @@
*/
public @interface Indexed {
/**
- * The filename of the index
+ * @return The filename of the index
*/
String index() default "";
}
Modified: search/trunk/src/java/org/hibernate/search/store/DirectoryProviderFactory.java
===================================================================
---
search/trunk/src/java/org/hibernate/search/store/DirectoryProviderFactory.java 2008-12-02
14:18:09 UTC (rev 15635)
+++
search/trunk/src/java/org/hibernate/search/store/DirectoryProviderFactory.java 2008-12-02
14:21:37 UTC (rev 15636)
@@ -22,20 +22,16 @@
import org.hibernate.util.StringHelper;
/**
- * Create a Lucene directory provider
- * <p/>
- * Lucene directory providers are configured through properties
+ * Create a Lucene directory provider which can be configured
+ * through the following properties:
* <ul>
- * <li>hibernate.search.default.* and</li>
- * <li>hibernate.search.<indexname>.*</li>
- * </ul>
+ * <li><i>hibernate.search.default.*</i></li>
+ * <li><i>hibernate.search.<indexname>.*</i>,</li>
+ * </ul>where <i><indexname></i> properties have
precedence over default ones.
* <p/>
- * <indexname> properties have precedence over default
- * <p/>
* The implementation is described by
- * hibernate.search.[default|indexname].directory_provider
- * <p/>
- * If none is defined the default value is FSDirectory
+ * <i>hibernate.search.[default|indexname].directory_provider</i>.
+ * If none is defined the default value is FSDirectory.
*
* @author Emmanuel Bernard
* @author Sylvain Vieujot
Modified: search/trunk/src/java/org/hibernate/search/store/FSDirectoryProvider.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/store/FSDirectoryProvider.java 2008-12-02
14:18:09 UTC (rev 15635)
+++ search/trunk/src/java/org/hibernate/search/store/FSDirectoryProvider.java 2008-12-02
14:21:37 UTC (rev 15636)
@@ -13,9 +13,15 @@
import org.hibernate.search.util.LoggerFactory;
/**
- * Use a Lucene FSDirectory
- * The base directory is represented by hibernate.search.<index>.indexBase
- * The index is created in <base directory>/<index name>
+ * Use a Lucene {@link FSDirectory}. The base directory is represented by the property
<i>hibernate.search.default.indexBase</i>
+ * or <i>hibernate.search.<index>.indexBase</i>. The former
defines the default base directory for all indexes whereas the
+ * latter allows to override the base directory on a per index basis.<i>
<index></i> has to be replaced with the fully qualified
+ * classname of the indexed class or the value of the <i>index</i> property
of the <code>@Indexed</code> annotation.
+ * <p>
+ * The actual index files are then created in
<i><indexBase>/<index name></i>,
<i><index name></i> is
+ * per default the name of the indexed entity, or the value of the
<i>index</i> property of the <code>@Indexed</code> or can be
specified
+ * as property in the configuration file using
<i>hibernate.search.<index>.indexName</i>.
+ * </p>
*
* @author Emmanuel Bernard
* @author Sylvain Vieujot
Show replies by thread