[hibernate-commits] Hibernate SVN: r14716 - in search/trunk/src/java/org/hibernate/search: backend/configuration and 2 other directories.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Fri May 30 11:49:58 EDT 2008 

Author: sannegrinovero
Date: 2008-05-30 11:49:57 -0400 (Fri, 30 May 2008)
New Revision: 14716

Modified:
   search/trunk/src/java/org/hibernate/search/annotations/ContainedIn.java
   search/trunk/src/java/org/hibernate/search/annotations/Factory.java
   search/trunk/src/java/org/hibernate/search/annotations/Key.java
   search/trunk/src/java/org/hibernate/search/backend/configuration/IndexWriterSetting.java
   search/trunk/src/java/org/hibernate/search/backend/impl/jms/AbstractJMSHibernateSearchController.java
   search/trunk/src/java/org/hibernate/search/store/DirectoryProviderHelper.java
Log:
javadoc: fix some warnings and formatting

Modified: search/trunk/src/java/org/hibernate/search/annotations/ContainedIn.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/ContainedIn.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/annotations/ContainedIn.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -9,28 +9,29 @@
 
 /**
  * Describe the owning entity as being part of the target entity's
- * index (to be more accurate, being part of the indexed object graph)
- *
- * Only necessary when an @Indexed class is used as a @IndexedEmbedded
- * target class. @ContainedIn must mark the property pointing back
- * to the @IndexedEmbedded owning Entity
- *
- * Not necessary if the class is an @Embeddable class.
- *
+ * index (to be more accurate, being part of the indexed object graph).
+ * <p>
+ * Only necessary when an &#64;Indexed class is used as a &#64;IndexedEmbedded
+ * target class. &#64;ContainedIn must mark the property pointing back
+ * to the &#64;IndexedEmbedded owning Entity.
+ * <p>
+ * Not necessary if the class is an &#64;Embeddable class.
+ * <p>
  * <code>
- * @Indexed
- * public class OrderLine {
- *     @IndexedEmbedded
- *     private Order order;
- * }
- *
- * @Indexed
- * public class Order {
- *     @ContainedBy
- *     Set<OrderLine> lines;
- * }
- * </code>
- *
+ * &#64;Indexed<br>
+ * public class OrderLine {<br>
+ *     &#64;IndexedEmbedded<br>
+ *     private Order order;<br>
+ * }<br>
+ *<br>
+ * &#64;Indexed<br>
+ * public class Order {<br>
+ *     &#64;ContainedBy<br>
+ *     Set<OrderLine> lines;<br>
+ * }<br>
+ * </code><br>
+ * @see org.hibernate.search.annotations.Indexed
+ * @see org.hibernate.search.annotations.IndexedEmbedded
  * @author Emmanuel Bernard
  */
 @Retention( RetentionPolicy.RUNTIME )

Modified: search/trunk/src/java/org/hibernate/search/annotations/Factory.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/Factory.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/annotations/Factory.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -12,9 +12,9 @@
  * A factory method is called whenever a new instance of a given
  * type is requested.
  * The factory method is used with a higher priority than a plain no-arg constructor when present
- *
- * @Factory currently works for @FullTextFilterDef.impl classes
- *
+ * <br />
+ * <code>&#64;Factory</code> currently works for &#64;FullTextFilterDef.impl classes
+ * @see org.hibernate.search.annotations.Factory
  * @author Emmanuel Bernard
  */
 @Retention( RetentionPolicy.RUNTIME )

Modified: search/trunk/src/java/org/hibernate/search/annotations/Key.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/annotations/Key.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/annotations/Key.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -14,8 +14,8 @@
  * The key object must implement equals / hashcode so that 2 keys are equals iif
  * the given target object types are the same, the set of parameters are the same.
  *
- * @Factory currently works for @FullTextFilterDef.impl classes
- *
+ * &#64;Factory currently works for &#64;FullTextFilterDef.impl classes
+ * @see org.hibernate.search.annotations.Factory
  * @author Emmanuel Bernard
  */
 @Retention( RetentionPolicy.RUNTIME )

Modified: search/trunk/src/java/org/hibernate/search/backend/configuration/IndexWriterSetting.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/configuration/IndexWriterSetting.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/backend/configuration/IndexWriterSetting.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -13,7 +13,7 @@
  */
 public enum IndexWriterSetting implements Serializable {
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setMaxBufferedDeleteTerms(int)
+	 * @see org.apache.lucene.index.IndexWriter#setMaxBufferedDeleteTerms(int)
 	 */
 	MAX_BUFFERED_DELETE_TERMS( "max_buffered_delete_terms" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -21,7 +21,7 @@
 		}
 	} ,
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setMaxBufferedDocs(int)
+	 * @see org.apache.lucene.index.IndexWriter#setMaxBufferedDocs(int)
 	 */
 	MAX_BUFFERED_DOCS( "max_buffered_docs" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -29,7 +29,7 @@
 		}
 	} ,
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setMaxFieldLength(int)
+	 * @see org.apache.lucene.index.IndexWriter#setMaxFieldLength(int)
 	 */
 	MAX_FIELD_LENGTH( "max_field_length" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -37,7 +37,7 @@
 		}
 	} ,
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setMaxMergeDocs(int)
+	 * @see org.apache.lucene.index.IndexWriter#setMaxMergeDocs(int)
 	 */
 	MAX_MERGE_DOCS( "max_merge_docs" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -45,7 +45,7 @@
 		}
 	} ,
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setMergeFactor(int)
+	 * @see org.apache.lucene.index.IndexWriter#setMergeFactor(int)
 	 */
 	MERGE_FACTOR( "merge_factor" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -53,7 +53,7 @@
 		}
 	} ,
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setRAMBufferSizeMB(int)
+	 * @see org.apache.lucene.index.IndexWriter#setRAMBufferSizeMB(double)
 	 */
 	RAM_BUFFER_SIZE( "ram_buffer_size" ) {
 		public void applySetting(IndexWriter writer, int value) {
@@ -61,7 +61,7 @@
 		}
 	},
 	/**
-	 * @see org.apache.lucene.index.IndexWriter.setTermIndexInterval(int)
+	 * @see org.apache.lucene.index.IndexWriter#setTermIndexInterval(int)
 	 */
 	TERM_INDEX_INTERVAL( "term_index_interval" ) {
 		public void applySetting(IndexWriter writer, int value) {

Modified: search/trunk/src/java/org/hibernate/search/backend/impl/jms/AbstractJMSHibernateSearchController.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/impl/jms/AbstractJMSHibernateSearchController.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/backend/impl/jms/AbstractJMSHibernateSearchController.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -20,7 +20,7 @@
  * Implement the Hibernate Search controller responsible for processing the
  * work send through JMS by the slave nodes.
  *
- * Note the subclass implementation has to implements javax.jms.MessageListener
+ * Note the subclass implementation has to implement javax.jms.MessageListener
  * //TODO Ask Bill why it is required
  *
  * @author Emmanuel Bernard
@@ -29,25 +29,28 @@
 	private static final Logger log = LoggerFactory.getLogger( AbstractJMSHibernateSearchController.class );
 
 	/**
-	 * return the current or give a new session
-	 * This session is not used per se, but is the link to access the Search configuration
-	 *
+	 * Return the current or give a new session
+	 * This session is not used per se, but is the link to access the Search configuration.
+	 * <p>
 	 * A typical EJB 3.0 usecase would be to get the session from the container (injected)
 	 * eg in JBoss EJB 3.0
+	 * <p>
 	 * <code>
-	 * @PersistenceContext private Session session;
-	 *
-	 * protected Session getSession() {
-	 *     return session
-	 * }
-	 *
-	 * eg in any container
+	 * &#64;PersistenceContext private Session session;<br>
+	 * <br>
+	 * protected Session getSession() {<br>
+	 *  &nbsp; &nbsp;return session<br>
+	 * }<br>
+	 * </code>
+	 * <p>
+	 * eg in any container<br>
 	 * <code>
-	 * @PersistenceContext private EntityManager entityManager;
-	 *
-	 * protected Session getSession() {
-	 *     return (Session) entityManager.getdelegate();
-	 * }
+	 * &#64;PersistenceContext private EntityManager entityManager;<br>
+	 * <br>
+	 * protected Session getSession() {<br>
+	 *  &nbsp; &nbsp;return (Session) entityManager.getdelegate();<br>
+	 * }<br>
+	 * </code>
 	 */
 	protected abstract Session getSession();
 

Modified: search/trunk/src/java/org/hibernate/search/store/DirectoryProviderHelper.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/store/DirectoryProviderHelper.java	2008-05-30 14:50:47 UTC (rev 14715)
+++ search/trunk/src/java/org/hibernate/search/store/DirectoryProviderHelper.java	2008-05-30 15:49:57 UTC (rev 14716)
@@ -30,7 +30,7 @@
 	 * @param directoryProviderName
 	 * @param properties
 	 * @param needWritePermissions when true the directory will be tested for read-write permissions. 
-	 * @return
+	 * @return The file representing the source directory
 	 */
 	public static File getSourceDirectory( String directoryProviderName, Properties properties, boolean needWritePermissions ) {
 		String root = properties.getProperty( ROOTINDEX_PROP_NAME );

More information about the hibernate-commits mailing list