Author: hardy.ferentschik Date: 2008-11-05 15:03:42 -0500 (Wed, 05 Nov 2008) New Revision: 15521 Modified: search/trunk/src/java/org/hibernate/search/reader/ReaderProvider.java search/trunk/src/java/org/hibernate/search/reader/SharedReaderProvider.java Log: Javadoc updates Modified: search/trunk/src/java/org/hibernate/search/reader/ReaderProvider.java =================================================================== --- search/trunk/src/java/org/hibernate/search/reader/ReaderProvider.java 2008-11-05 19:20:28 UTC (rev 15520) +++ search/trunk/src/java/org/hibernate/search/reader/ReaderProvider.java 2008-11-05 20:03:42 UTC (rev 15521) @@ -8,36 +8,35 @@ import org.hibernate.search.engine.SearchFactoryImplementor; /** - * Responsible for providing and managing the lifecycle of a read only reader + * Responsible for providing and managing the lifecycle of a read only reader. The implementation must have a + * no-arg constructor. * <p/> - * Not that the reader must be closed once opened. + * Note that the reader must be closed once opened. * - * The ReaderProvider implementation must have a no-arg constructor - * * @author Emmanuel Bernard */ public interface ReaderProvider { /** - * Open a reader on all the listed directory providers - * the opened reader has to be closed through #closeReader() - * The opening can be virtual + * Open a reader on all the listed directory providers. + * The opened reader has to be closed through {@link #closeReader(IndexReader)}. + * The opening can be virtual. */ IndexReader openReader(DirectoryProvider... directoryProviders); /** - * close a reader previously opened by #openReader - * The closing can be virtual + * Close a reader previously opened by {@link #openReader}. + * The closing can be virtual. */ void closeReader(IndexReader reader); /** - * inialize the reader provider before its use + * Inialize the reader provider before its use. */ void initialize(Properties props, SearchFactoryImplementor searchFactoryImplementor); /** - * called when a SearchFactory is destroyed. This method typically releases resources - * This method is guaranteed to be executed after readers are released by queries (assuming no user error). + * Called when a <code>SearchFactory</code> is destroyed. This method typically releases resources. + * It is guaranteed to be executed after readers are released by queries (assuming no user error). */ void destroy(); } Modified: search/trunk/src/java/org/hibernate/search/reader/SharedReaderProvider.java =================================================================== --- search/trunk/src/java/org/hibernate/search/reader/SharedReaderProvider.java 2008-11-05 19:20:28 UTC (rev 15520) +++ search/trunk/src/java/org/hibernate/search/reader/SharedReaderProvider.java 2008-11-05 20:03:42 UTC (rev 15521) @@ -23,7 +23,8 @@ import org.hibernate.search.util.LoggerFactory; /** - * Share readers per SearchFactory, reusing them iff they are still valid. + * Share readers per <code>SearchFactory</code>, reusing them if they are still valid. + * * @Deprecated replaced by SharingBufferReaderProvider * @author Emmanuel Bernard */