docs: minimal Javadoc clean up to pass publishing action (#104)

Author: bsbodden

redis-om-spring/src/main/java/com/redis/om/spring/RedisEnhancedKeyValueAdapter.java

@@ -86,6 +86,8 @@ public class RedisEnhancedKeyValueAdapter extends RedisKeyValueAdapter {
    * {@link RedisMappingContext} and default {@link RedisCustomConversions}.
    *
    * @param redisOps must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
    */
   public RedisEnhancedKeyValueAdapter(RedisOperations<?, ?> redisOps, RedisModulesOperations<?> rmo,
       KeyspaceToIndexMap keyspaceToIndexMap) {
@@ -96,8 +98,10 @@ public RedisEnhancedKeyValueAdapter(RedisOperations<?, ?> redisOps, RedisModules
    * Creates new {@link RedisKeyValueAdapter} with default
    * {@link RedisCustomConversions}.
    *
-   * @param redisOps       must not be {@literal null}.
+   * @param redisOps must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
    * @param mappingContext must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
    */
   public RedisEnhancedKeyValueAdapter(RedisOperations<?, ?> redisOps, RedisModulesOperations<?> rmo,
       RedisMappingContext mappingContext, KeyspaceToIndexMap keyspaceToIndexMap) {
@@ -107,10 +111,11 @@ public RedisEnhancedKeyValueAdapter(RedisOperations<?, ?> redisOps, RedisModules
   /**
    * Creates new {@link RedisKeyValueAdapter}.
    *
-   * @param redisOps          must not be {@literal null}.
-   * @param mappingContext    must not be {@literal null}.
+   * @param redisOps  must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param mappingContext  must not be {@literal null}.
    * @param customConversions can be {@literal null}.
-   * @since 2.0
+   * @param keyspaceToIndexMap must not be {@literal null}.
    */
   @SuppressWarnings("unchecked")
   public RedisEnhancedKeyValueAdapter(RedisOperations<?, ?> redisOps, RedisModulesOperations<?> rmo,
@@ -254,9 +259,8 @@ public void deleteAllOf(String keyspace) {
    * @param type     the desired target type.
    * @param offset   index value to start reading.
    * @param rows     maximum number or entities to return.
-   * @param <T>
+   * @param <T>      type of entity
    * @return never {@literal null}.
-   * @since 2.5
    */
   @Override
   public <T> List<T> getAllOf(String keyspace, Class<T> type, long offset, int rows) {

redis-om-spring/src/main/java/com/redis/om/spring/annotations/Document.java

@@ -29,7 +29,7 @@
   double score() default 1.0; 
 
   /**
-   * Time before expire in seconds. Superseded by {@link TimeToLive}.
+   * Time before expire in seconds.
    *
    * @return positive number when expiration should be applied.
    */

redis-om-spring/src/main/java/com/redis/om/spring/annotations/EnableRedisDocumentRepositories.java

@@ -163,7 +163,7 @@
    * used for keyspace event subscriptions. Defaults to use an anonymous managed instance by
    * {@link org.springframework.data.redis.core.RedisKeyValueAdapter}.
    *
-   * @return
+   * @return the messageListenerContainerRef
    * @since 2.7.2
    */
   String messageListenerContainerRef() default "";

redis-om-spring/src/main/java/com/redis/om/spring/annotations/EnableRedisEnhancedRepositories.java

@@ -162,8 +162,7 @@
    * used for keyspace event subscriptions. Defaults to use an anonymous managed instance by
    * {@link org.springframework.data.redis.core.RedisKeyValueAdapter}.
    *
-   * @return
-   * @since 2.7.2
+   * @return the messageListenerContainerRef
    */
   String messageListenerContainerRef() default "";
 

redis-om-spring/src/main/java/com/redis/om/spring/convert/MappingRedisOMConverter.java

@@ -99,7 +99,6 @@ public MappingRedisOMConverter(RedisMappingContext context) {
    * {@link RedisMappingContext} when {@literal null}.
    *
    * @param mappingContext    can be {@literal null}.
-   * @param indexResolver     can be {@literal null}.
    * @param referenceResolver can be not be {@literal null}.
    */
   public MappingRedisOMConverter(@Nullable RedisMappingContext mappingContext,
@@ -112,7 +111,6 @@ public MappingRedisOMConverter(@Nullable RedisMappingContext mappingContext,
    * {@link RedisMappingContext} when {@literal null}.
    *
    * @param mappingContext    can be {@literal null}.
-   * @param indexResolver     can be {@literal null}.
    * @param referenceResolver can be {@literal null}.
    * @param typeMapper        can be {@literal null}.
    */
@@ -987,9 +985,9 @@ private Class<?> getTypeHint(String path, Bucket bucket, Class<?> fallback) {
    * Convert given source to binary representation using the underlying
    * {@link ConversionService}.
    *
-   * @param source
-   * @return
-   * @throws ConverterNotFoundException
+   * @param source the source object
+   * @return a byte array representation
+   * @throws ConverterNotFoundException if a specific converter cannot be found
    */
   public byte[] toBytes(Object source) {
 
@@ -1004,10 +1002,11 @@ public byte[] toBytes(Object source) {
    * Convert given binary representation to desired target type using the
    * underlying {@link ConversionService}.
    *
-   * @param source
-   * @param type
-   * @return
-   * @throws ConverterNotFoundException
+   * @param <T> expected type of the source object
+   * @param source  the source object
+   * @param type the class to cast the object to
+   * @return the target object
+   * @throws ConverterNotFoundException if a specific converter cannot be found
    */
   public <T> T fromBytes(byte[] source, Class<T> type) {
 
@@ -1055,7 +1054,7 @@ public void setReferenceResolver(ReferenceResolver referenceResolver) {
   /**
    * Set {@link CustomConversions} to be applied.
    *
-   * @param customConversions
+   * @param customConversions custom convertions to be added to the pipeline
    */
   public void setCustomConversions(@Nullable CustomConversions customConversions) {
     this.customConversions = customConversions != null ? customConversions : new RedisCustomConversions();

redis-om-spring/src/main/java/com/redis/om/spring/convert/RedisOMCustomConversions.java

@@ -38,7 +38,7 @@ public RedisOMCustomConversions() {
   /**
    * Creates a new {@link RedisCustomConversions} instance registering the given converters.
    *
-   * @param converters
+   * @param converters a list of converted to be added to the base list
    */
   public RedisOMCustomConversions(List<?> converters) {
     super(omConverters);

redis-om-spring/src/main/java/com/redis/om/spring/repository/RedisDocumentRepository.java

@@ -16,7 +16,7 @@ public interface RedisDocumentRepository<T, ID> extends KeyValueRepository<T, ID
   /**
    * Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
    *
-   * @param pageable
+   * @param pageable encapsulates pagination information
    * @return a page of entities
    */
   Page<ID> getIds(Pageable pageable);

redis-om-spring/src/main/java/com/redis/om/spring/repository/RedisEnhancedRepository.java

@@ -15,7 +15,7 @@ public interface RedisEnhancedRepository<T, ID> extends KeyValueRepository<T, ID
   /**
    * Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
    *
-   * @param pageable
+   * @param pageable encapsulates pagination information
    * @return a page of entities
    */
   Page<ID> getIds(Pageable pageable);

redis-om-spring/src/main/java/com/redis/om/spring/repository/query/Sort.java

@@ -17,7 +17,7 @@ protected Sort(List<Order> orders) {
    *
    * @param direction must not be {@literal null}.
    * @param fields must not be {@literal null}.
-   * @return
+   * @return a Spring Sort object
    */
   public static org.springframework.data.domain.Sort by(Direction direction, MetamodelField<?, ?>... fields) {
     String[] properties = Arrays.asList(fields).stream().map(metamodel ->  metamodel.getField().getName()).toArray(String[]::new);

redis-om-spring/src/main/java/com/redis/om/spring/repository/support/RedisDocumentRepositoryFactory.java

@@ -46,6 +46,8 @@ public class RedisDocumentRepositoryFactory extends KeyValueRepositoryFactory {
    *
    * @param keyValueOperations must not be {@literal null}.
    * @param rmo                must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
+   * @param mappingContext     must not be {@literal null}.
    */
   public RedisDocumentRepositoryFactory( //
       KeyValueOperations keyValueOperations, //
@@ -60,7 +62,10 @@ public RedisDocumentRepositoryFactory( //
    * {@link KeyValueOperations} and {@link AbstractQueryCreator}-type.
    *
    * @param keyValueOperations must not be {@literal null}.
-   * @param queryCreator       must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
+   * @param queryCreator must not be {@literal null}.
+   * @param mappingContext must not be {@literal null}.
    */
   public RedisDocumentRepositoryFactory( //
       KeyValueOperations keyValueOperations, //
@@ -76,9 +81,12 @@ public RedisDocumentRepositoryFactory( //
    * Creates a new {@link KeyValueRepositoryFactory} for the given
    * {@link KeyValueOperations} and {@link AbstractQueryCreator}-type.
    *
-   * @param keyValueOperations  must not be {@literal null}.
-   * @param queryCreator        must not be {@literal null}.
+   * @param keyValueOperations must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
+   * @param queryCreator must not be {@literal null}.
    * @param repositoryQueryType must not be {@literal null}.
+   * @param mappingContext must not be {@literal null}.
    */
   public RedisDocumentRepositoryFactory( //
       KeyValueOperations keyValueOperations, // 

redis-om-spring/src/main/java/com/redis/om/spring/repository/support/RedisEnhancedRepositoryFactory.java

@@ -50,6 +50,9 @@ public class RedisEnhancedRepositoryFactory extends RepositoryFactorySupport {
    * {@link KeyValueOperations}.
    *
    * @param keyValueOperations must not be {@literal null}.
+   * @param redisOperations  must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
    */
   public RedisEnhancedRepositoryFactory( //
       KeyValueOperations keyValueOperations, //
@@ -64,7 +67,10 @@ public RedisEnhancedRepositoryFactory( //
    * {@link KeyValueOperations} and {@link AbstractQueryCreator}-type.
    *
    * @param keyValueOperations must not be {@literal null}.
-   * @param queryCreator       must not be {@literal null}.
+   * @param redisOperations must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
+   * @param queryCreator must not be {@literal null}.
    */
   public RedisEnhancedRepositoryFactory( //
                                          KeyValueOperations keyValueOperations, //
@@ -80,10 +86,12 @@ public RedisEnhancedRepositoryFactory( //
    * Creates a new {@link KeyValueRepositoryFactory} for the given
    * {@link KeyValueOperations} and {@link AbstractQueryCreator}-type.
    *
-   * @param keyValueOperations  must not be {@literal null}.
-   * @param queryCreator        must not be {@literal null}.
+   * @param keyValueOperations must not be {@literal null}.
+   * @param redisOperations must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
+   * @param queryCreator must not be {@literal null}.
    * @param repositoryQueryType must not be {@literal null}.
-   * @since 1.1
    */
   public RedisEnhancedRepositoryFactory( //
                                          KeyValueOperations keyValueOperations, //

redis-om-spring/src/main/java/com/redis/om/spring/repository/support/RedisEnhancedRepositoryFactoryBean.java

@@ -32,6 +32,9 @@ public class RedisEnhancedRepositoryFactoryBean<T extends Repository<S, ID>, S,
    * interface.
    *
    * @param repositoryInterface must not be {@literal null}.
+   * @param redisOperations must not be {@literal null}.
+   * @param rmo must not be {@literal null}.
+   * @param keyspaceToIndexMap must not be {@literal null}.
    */
   public RedisEnhancedRepositoryFactoryBean(Class<? extends T> repositoryInterface,
       RedisOperations<?, ?> redisOperations, RedisModulesOperations<?> rmo, KeyspaceToIndexMap keyspaceToIndexMap) {