Fix more javadoc issues

Blazebit · Apr 19, 2015 · 6e24314 · 6e24314
1 parent 7f82eed
commit 6e24314
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/core/api/src/main/java/com/blazebit/persistence/BaseQueryBuilder.java b/core/api/src/main/java/com/blazebit/persistence/BaseQueryBuilder.java
@@ -30,20 +30,20 @@ public interface BaseQueryBuilder<T, X extends BaseQueryBuilder<T, X>> extends W
         OrderByBuilder<X>, SelectBuilder<T, X> {
 
     /**
-     * Like {@link CriteriaBuilderFactory#from(java.lang.Class, java.lang.String)} with the
+     * Like {@link BaseQueryBuilder#from(java.lang.Class, java.lang.String)} with the
      * alias equivalent to the camel cased result of what {@link Class#getSimpleName()} of the entity class returns.
      *
      * @param entityClass   The entity class which should be the root entity
-     * @return A new criteria builder
+     * @return The query builder for chaining calls
      */
     public BaseQueryBuilder<T, ?> from(Class<?> entityClass);
 
     /**
-     * Adds a entity class to the from clause of the query with the given alias.
+     * Sets the entity class on which the query should be based on with the given alias.
      *
      * @param entityClass   The entity class which should be the root entity
      * @param alias         The alias for the root entity
-     * @return A new criteria builder
+     * @return The query builder for chaining calls
      */
     public BaseQueryBuilder<T, ?> from(Class<?> entityClass, String alias);
 

diff --git a/core/api/src/main/java/com/blazebit/persistence/CriteriaBuilderFactory.java b/core/api/src/main/java/com/blazebit/persistence/CriteriaBuilderFactory.java
@@ -27,7 +27,7 @@ public interface CriteriaBuilderFactory {
 
     /**
      * Like {@link CriteriaBuilderFactory#create(javax.persistence.EntityManager, java.lang.Class, java.lang.String) 
-     * but with a default alias of <code>resultClass.getSimpleName()</code> in camelcase.
+     * but with the alias equivalent to the camel cased result of what {@link Class#getSimpleName()} of the result class returns.
      *
      * @param entityManager The entity manager to use for the criteria builder
      * @param resultClass   The result class of the query
@@ -37,7 +37,8 @@ public interface CriteriaBuilderFactory {
     public <T> CriteriaBuilder<T> create(EntityManager entityManager, Class<T> resultClass);
 
     /**
-     * Creates a new criteria builder with the given result class.
+     * Creates a new criteria builder with the given result class. The result class will be used as default from class.
+     * The alias will be used as default alias for the from class. Both can be overridden by invoking {@link BaseQueryBuilder#from(java.lang.Class, java.lang.String)}.
      *
      * @param entityManager The entity manager to use for the criteria builder
      * @param resultClass   The result class of the query