Author: hardy.ferentschik
Date: 2008-10-29 12:51:52 -0400 (Wed, 29 Oct 2008)
New Revision: 15437

Modified:
 search/trunk/src/java/org/hibernate/search/backend/BackendQueueProcessorFactory.java
 search/trunk/src/java/org/hibernate/search/backend/TransactionContext.java
Log:
Javadoc changes

Modified: search/trunk/src/java/org/hibernate/search/backend/BackendQueueProcessorFactory.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/BackendQueueProcessorFactory.java  2008-10-29 16:34:25 UTC (rev 15436)
+++ search/trunk/src/java/org/hibernate/search/backend/BackendQueueProcessorFactory.java  2008-10-29 16:51:52 UTC (rev 15437)
@@(protected) @@
import org.hibernate.search.engine.SearchFactoryImplementor;

/**
- * Build stateful backend processor
- * Must have a no arg constructor
- * The factory typically prepare or pool the resources needed by the queue processor
+ * Interface for different types of queue processor factories. Implementations need a no-arg constructor.
+ * The factory typically prepares or pools the resources needed by the queue processor.
*
* @author Emmanuel Bernard
*/
@@(protected) @@
 void initialize(Properties props, SearchFactoryImplementor searchFactory);

 /**
-   * Return a runnable implementation responsible for processing the queue to a given backend
+   * Return a runnable implementation responsible for processing the queue to a given backend.
+   *
+   * @param queue The work queue to process.
+   * @return <code>Runnable</code> which processes <code>queue</code> when started.
  */
-
 Runnable getProcessor(List<LuceneWork> queue);
}

Modified: search/trunk/src/java/org/hibernate/search/backend/TransactionContext.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/TransactionContext.java  2008-10-29 16:34:25 UTC (rev 15436)
+++ search/trunk/src/java/org/hibernate/search/backend/TransactionContext.java  2008-10-29 16:51:52 UTC (rev 15437)
@@(protected) @@
import javax.transaction.Synchronization;

/**
- * Contract needed by Hibernate Search to bach changes per transactio
+ * Contract needed by Hibernate Search to batch changes per transaction.
*
* @author Navin Surtani - navin@(protected)
*/
public interface TransactionContext {
 /**
-   * @return A boolean whether a transaction is in progress or not.
+   * @return A boolean indicating whether a transaction is in progress or not.
  */
 public boolean isTransactionInProgress();

@@(protected) @@
 public Object getTransactionIdentifier();

 /**
-   * register the givne synchronization
+   * Register the given synchronization.
  *
  * @param synchronization synchronization to register
  */

_______________________________________________
hibernate-commits mailing list
hibernate-commits@(protected)
https://lists.jboss.org/mailman/listinfo/hibernate-commits