minor change, correct javadoc and typo

hibernate-core/src/main/java/org/hibernate/annotations/AnyMetaDef.java

@@ -50,7 +50,7 @@ public @interface AnyMetaDef {
 
 	/**
 	 * Hibernate type of the id column
-	 * @return
+	 * @return Hibernate type of the id column
 	 */
 	String idType();
 

hibernate-core/src/main/java/org/hibernate/annotations/SourceType.java

@@ -33,7 +33,6 @@ package org.hibernate.annotations;
 public enum SourceType {
 	/**
 	 * Get the timestamp from the current VM.
-	 * @see 
 	 */
 	VM("timestamp"),
 

hibernate-core/src/main/java/org/hibernate/bytecode/buildtime/spi/AbstractInstrumenter.java

@@ -125,7 +125,7 @@ public abstract class AbstractInstrumenter implements Instrumenter {
 	}
 
 	/**
-	 * Extract the names of classes from file, addding them to the classNames collection.
+	 * Extract the names of classes from file, adding them to the classNames collection.
 	 * <p/>
 	 * IMPL NOTE : file here may be either a class file or a jar.  If a jar, all entries in the jar file are
 	 * processed.
@@ -202,7 +202,7 @@ public abstract class AbstractInstrumenter implements Instrumenter {
 	 *
 	 * @param file The file to process.
 	 * @param classNames The 'pipeline' of classes to be processed.  Only actually populated when the user
-	 * specifies to perform {@link Options#performExtendedInstrumentation() extended} instrumentation.
+	 * specifies to perform {@link org.hibernate.bytecode.buildtime.spi.Instrumenter.Options#performExtendedInstrumentation() extended} instrumentation.
 	 *
 	 * @throws Exception Indicates an issue either access files or applying the transformations.
 	 */
@@ -225,7 +225,7 @@ public abstract class AbstractInstrumenter implements Instrumenter {
 	 *
 	 * @param file The class file to process.
 	 * @param classNames The 'pipeline' of classes to be processed.  Only actually populated when the user
-	 * specifies to perform {@link Options#performExtendedInstrumentation() extended} instrumentation.
+	 * specifies to perform {@link org.hibernate.bytecode.buildtime.spi.Instrumenter.Options#performExtendedInstrumentation() extended} instrumentation.
 	 *
 	 * @throws Exception Indicates an issue either access files or applying the transformations.
 	 */
@@ -267,7 +267,7 @@ public abstract class AbstractInstrumenter implements Instrumenter {
 	 *
 	 * @param file The archive file to process.
 	 * @param classNames The 'pipeline' of classes to be processed.  Only actually populated when the user
-	 * specifies to perform {@link Options#performExtendedInstrumentation() extended} instrumentation.
+	 * specifies to perform {@link org.hibernate.bytecode.buildtime.spi.Instrumenter.Options#performExtendedInstrumentation() extended} instrumentation.
 	 *
 	 * @throws Exception Indicates an issue either access files or applying the transformations.
 	 */
@@ -352,7 +352,7 @@ public abstract class AbstractInstrumenter implements Instrumenter {
 	}
 
 	/**
-	 * Allows control over what exacctly to transform.
+	 * Allows control over what exactly to transform.
 	 */
 	protected class CustomFieldFilter implements FieldFilter {
 		private final ClassDescriptor descriptor;

hibernate-core/src/main/java/org/hibernate/bytecode/internal/javassist/AccessOptimizerAdapter.java

@@ -29,7 +29,7 @@ import org.hibernate.PropertyAccessException;
 import org.hibernate.bytecode.spi.ReflectionOptimizer;
 
 /**
- * The {@link ReflectionOptimizer.AccessOptimizer} implementation for Javassist
+ * The {@link org.hibernate.bytecode.spi.ReflectionOptimizer.AccessOptimizer} implementation for Javassist
  * which simply acts as an adapter to the {@link BulkAccessor} class.
  *
  * @author Steve Ebersole

hibernate-core/src/main/java/org/hibernate/cache/spi/OptimisticCacheSource.java

@@ -49,7 +49,7 @@ public interface OptimisticCacheSource {
 	 * Get the comparator used to compare two different version values.
 	 * <p/>
 	 * May return null <b>if</b> {@link #isVersioned()} returns false.
-	 * @return
+	 * @return Comparator used to compare two different version values.
 	 */
 	public Comparator getVersionComparator();
 }

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -1880,7 +1880,6 @@ public abstract class Dialect {
 	 * <p/>
 	 * Note that the spaces are important!
 	 *
-	 * @return
 	 */
 	public String getCrossJoinSeparator() {
 		return " cross join ";

hibernate-core/src/main/java/org/hibernate/event/spi/LoadEventListener.java

@@ -38,7 +38,6 @@ public interface LoadEventListener extends Serializable {
 	 * Handle the given load event.
      *
      * @param event The load event to be handled.
-     * @return The result (i.e., the loaded entity).
      * @throws HibernateException
      */
 	public void onLoad(LoadEvent event, LoadType loadType) throws HibernateException;

hibernate-core/src/main/java/org/hibernate/mapping/PersistentClassVisitor.java

@@ -30,34 +30,18 @@ package org.hibernate.mapping;
  */
 public interface PersistentClassVisitor {
 
-	/**
-	 * @param class1
-	 * @return
-	 */
+
 	Object accept(RootClass class1);
 
-	/**
-	 * @param subclass
-	 * @return
-	 */
+
 	Object accept(UnionSubclass subclass);
 
-	/**
-	 * @param subclass
-	 * @return
-	 */
 	Object accept(SingleTableSubclass subclass);
 
-	/**
-	 * @param subclass
-	 * @return
-	 */
+
 	Object accept(JoinedSubclass subclass);
 
-	/**
-	 * @param subclass
-	 * @return
-	 */
+
 	Object accept(Subclass subclass);
 
 	

hibernate-core/src/main/java/org/hibernate/persister/entity/Queryable.java

@@ -53,7 +53,7 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	public String getDiscriminatorSQLValue();
 
 	/**
-	 * Given a query alias and an identifying suffix, render the intentifier select fragment.
+	 * Given a query alias and an identifying suffix, render the identifier select fragment.
 	 */
 	public String identifierSelectFragment(String name, String suffix);
 	/**
@@ -68,16 +68,16 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	public String[] getIdentifierColumnNames();
 
 	/**
-	 * Is the inheritence hierarchy described by this persister contained across
+	 * Is the inheritance hierarchy described by this persister contained across
 	 * multiple tables?
 	 *
-	 * @return True if the inheritence hierarchy is spread across multiple tables; false otherwise.
+	 * @return True if the inheritance hierarchy is spread across multiple tables; false otherwise.
 	 */
 	public boolean isMultiTable();
 
 	/**
 	 * Get the names of all tables used in the hierarchy (up and down) ordered such
-	 * that deletes in the given order would not cause contraint violations.
+	 * that deletes in the given order would not cause constraint violations.
 	 *
 	 * @return The ordered array of table names.
 	 */
@@ -91,9 +91,8 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	 * {@link #getConstraintOrderedTableNameClosure()}.
 	 * <p/>
 	 * The second dimension should have the same length across all the elements in
-	 * the first dimension.  If not, that'd be a problem ;)
+	 * the first dimension.  If not, that would be a problem ;)
 	 *
-	 * @return
 	 */
 	public String[][] getContraintOrderedTableKeyColumnClosure();
 
@@ -122,7 +121,7 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	 * It is also relative to the indexing used to resolve {@link #getSubclassTableName}...
 	 *
 	 * @param propertyPath The name of the property.
-	 * @return The nunber of the table to which the property is mapped.
+	 * @return The number of the table to which the property is mapped.
 	 */
 	public int getSubclassPropertyTableNumber(String propertyPath);
 
@@ -143,7 +142,6 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	 * array.
 	 *
 	 * @param number The index into the internal array.
-	 * @return
 	 */
 	public String getSubclassTableName(int number);
 
@@ -157,7 +155,7 @@ public interface Queryable extends Loadable, PropertyMapping, Joinable {
 	 * enabled-filters).
 	 * </p>
 	 * This may or may not be different from the root alias depending upon the
-	 * inheritence mapping strategy.
+	 * inheritance mapping strategy.
 	 *
 	 * @param rootAlias The root alias
 	 * @return The alias used for "filter conditions" within the where clause.

hibernate-core/src/main/java/org/hibernate/proxy/AbstractLazyInitializer.java

@@ -267,7 +267,7 @@ public abstract class AbstractLazyInitializer implements LazyInitializer {
 	 * This method should only be called during serialization when read-only/modifiable setting
 	 * is not available (i.e., isReadOnlySettingAvailable() == false)
 	 *
-	 * @returns, null, if the default setting should be used;
+	 * @return null, if the default setting should be used;
 	 *           true, for read-only;
 	 *           false, for modifiable
 	 * @throws IllegalStateException if isReadOnlySettingAvailable() == true

hibernate-core/src/main/java/org/hibernate/proxy/LazyInitializer.java

@@ -137,12 +137,12 @@ public interface LazyInitializer {
 	 * If the associated proxy already has the specified read-only/modifiable
 	 * setting, then this method does nothing.
 	 *
-	 * @param readOnly, if true, the associated proxy is made read-only;
+	 * @param readOnly if true, the associated proxy is made read-only;
 	 *                  if false, the associated proxy is made modifiable.
 	 * @throws org.hibernate.TransientObjectException if the proxy is not association with a session
 	 * @throws org.hibernate.SessionException if the proxy is associated with a sesssion that is closed
 	 * 
-	 * @see org.hibernate.Session#setReadOnly(Object entityOrProxy, boolean readOnly)
+	 * @see {@link org.hibernate.Session#setReadOnly(Object entityOrProxy, boolean readOnly)}
 	 */
 	public void setReadOnly(boolean readOnly);
 

hibernate-core/src/main/java/org/hibernate/service/internal/ServiceProxy.java

@@ -33,9 +33,6 @@ import org.hibernate.service.Service;
 public interface ServiceProxy extends Service {
 	/**
 	 * Get the target service instance represented by this proxy.
-	 *
-	 * @param <T>
-	 * @return
 	 */
 	public <T extends Service> T getTargetInstance();
 }

hibernate-core/src/main/java/org/hibernate/type/descriptor/sql/SqlTypeDescriptor.java

@@ -38,7 +38,7 @@ public interface SqlTypeDescriptor extends Serializable {
 	/**
 	 * Return the {@linkplain java.sql.Types JDBC type-code} for the column mapped by this type.
 	 *
-	 * @return The JDBC type-code
+	 * @return typeCode The JDBC type-code
 	 */
 	public int getSqlType();
 

hibernate-core/src/main/java/org/hibernate/usertype/CompositeUserType.java

@@ -100,10 +100,7 @@ public interface CompositeUserType {
 	/**
 	 * Compare two instances of the class mapped by this type for persistence "equality".
 	 * Equality of the persistent state.
-	 *
-	 * @param x
-	 * @param y
-	 * @return boolean
+     *
 	 * @throws HibernateException
 	 */
 	public boolean equals(Object x, Object y) throws HibernateException;
@@ -193,11 +190,6 @@ public interface CompositeUserType {
 	 * composite user types often define component values, it might make sense to recursively
 	 * replace component values in the target object.
 	 *
-	 * @param original
-	 * @param target
-	 * @param session
-	 * @param owner
-	 * @return
 	 * @throws HibernateException
 	 */
 	public Object replace(Object original, Object target, SessionImplementor session, Object owner) 

hibernate-envers/src/main/java/org/hibernate/envers/query/impl/AbstractAuditQuery.java

@@ -191,7 +191,7 @@ public abstract class AbstractAuditQuery implements AuditQuery {
 
 	/**
 	 * Set lock mode
-	 * @param lockMode
+	 * @param lockMode The {@link LockMode} used for this query.
 	 * @return this object
 	 * @deprecated Instead use setLockOptions
 	 */
@@ -202,7 +202,7 @@ public abstract class AbstractAuditQuery implements AuditQuery {
 
 	/**
 	 * Set lock options
-	 * @param lockOptions
+	 * @param lockOptions The @{link LockOptions} used for this query.
 	 * @return this object
 	 */
 	public AuditQuery setLockOptions(LockOptions lockOptions) {

hibernate-envers/src/main/java/org/hibernate/envers/reader/FirstLevelCache.java

@@ -70,10 +70,10 @@ public class FirstLevelCache {
 
     /**
      * Adds the entityName into the cache. The key is a triple make with primaryKey, revision and entity
-     * @param entityName, value of the cache
      * @param id, primaryKey
      * @param revision, revision number
      * @param entity, object retrieved by envers
+     * @param entityName, value of the cache
      */
     public void putOnEntityNameCache(Object id, Number revision, Object entity, String entityName) {
         LOG.debugf("Caching entityName on First Level Cache:  - primaryKey:%s - revision:%s - entity:%s -> entityName:%s",
@@ -86,7 +86,6 @@ public class FirstLevelCache {
 
     /**
      * Gets the entityName from the cache. The key is a triple make with primaryKey, revision and entity
-     * @param entityName, value of the cache
      * @param id, primaryKey
      * @param revision, revision number
      * @param entity, object retrieved by envers
@@ -100,12 +99,9 @@ public class FirstLevelCache {
     }
 
 	/**
-	 * @param id
-	 *            , primaryKey
-	 * @param revision
-	 *            , revision number
-	 * @param entity
-	 *            , object retrieved by envers
+	 * @param id primaryKey
+	 * @param revision revision number
+	 * @param entity object retrieved by envers
 	 * @return true if entityNameCache contains the triple
 	 */
     public boolean containsEntityName(Object id, Number revision, Object entity) {