fix(javadoc): add comprehensive Javadoc and suppress Lombok warnings

- Added complete Javadoc to FilterQuery getters and builder methods
- Added complete Javadoc to HybridQuery getters
- Added Javadoc to Route.RouteBuilder.references() method
- Added @SuppressWarnings("javadoc") to Lombok classes (Route, RouteMatch, RoutingConfig, SemanticRouterBuilder)
- Configured aggregateJavadoc task to suppress missing constructor warnings (-Xdoclint:-missing)

Author: bsbodden

build.gradle.kts

@@ -170,6 +170,8 @@ tasks.register<Javadoc>("aggregateJavadoc") {
             "https://docs.oracle.com/en/java/javase/17/docs/api/",
             "https://www.javadoc.io/doc/redis.clients/jedis/latest/"
         )
+        // Suppress warnings for Lombok-generated constructors
+        addStringOption("Xdoclint:-missing", "-quiet")
     }
 
     // Ensure Javadoc generation succeeds

core/src/main/java/com/redis/vl/extensions/router/Route.java

@@ -12,8 +12,9 @@
 import lombok.Data;
 
 /**
- * Model representing a routing path with associated metadata and thresholds. Ported from Python:
- * redisvl/extensions/router/schema.py:12
+ * Model representing a routing path with associated metadata and thresholds.
+ *
+ * <p>Ported from Python: redisvl/extensions/router/schema.py:12
  */
 @Data
 @Builder
@@ -23,14 +24,22 @@
     value = {"EI_EXPOSE_REP", "EI_EXPOSE_REP2"},
     justification =
         "Route is a data class with intentionally mutable fields for Python API compatibility")
+@SuppressWarnings("javadoc") // Lombok generates constructors
 public class Route {
   private String name;
   private List<String> references;
   @Builder.Default private Map<String, Object> metadata = Map.of();
   @Builder.Default private double distanceThreshold = 0.5;
 
   /** Custom builder to ensure references list is mutable. */
+  @SuppressWarnings("javadoc") // Lombok generates constructors
   public static class RouteBuilder {
+    /**
+     * Set the references list with a mutable copy.
+     *
+     * @param references List of reference strings
+     * @return this builder
+     */
     public RouteBuilder references(List<String> references) {
       // Convert to ArrayList to ensure mutability for addRouteReferences/deleteRouteReferences
       this.references = references != null ? new ArrayList<>(references) : new ArrayList<>();

core/src/main/java/com/redis/vl/query/FilterQuery.java

@@ -45,7 +45,11 @@ private FilterQuery(FilterQueryBuilder builder) {
     this.params = builder.params != null ? Map.copyOf(builder.params) : Map.of();
   }
 
-  /** Create a new builder. */
+  /**
+   * Create a new builder.
+   *
+   * @return A new FilterQueryBuilder instance
+   */
   public static FilterQueryBuilder builder() {
     return new FilterQueryBuilder();
   }
@@ -119,30 +123,66 @@ public Query buildRedisQuery() {
   }
 
   // Getters
+
+  /**
+   * Get the filter expression.
+   *
+   * @return The filter expression
+   */
   public Filter getFilterExpression() {
     return filterExpression;
   }
 
+  /**
+   * Get the fields to return in results.
+   *
+   * @return List of field names to return
+   */
   public List<String> getReturnFields() {
     return returnFields;
   }
 
+  /**
+   * Get the number of results to return.
+   *
+   * @return Number of results
+   */
   public int getNumResults() {
     return numResults;
   }
 
+  /**
+   * Get the query dialect.
+   *
+   * @return RediSearch dialect version
+   */
   public int getDialect() {
     return dialect;
   }
 
+  /**
+   * Get the field to sort by.
+   *
+   * @return Sort field name, or null if not sorting
+   */
   public String getSortBy() {
     return sortBy;
   }
 
+  /**
+   * Check if in-order matching is required.
+   *
+   * @return true if terms must appear in same order as query
+   */
   public boolean isInOrder() {
     return inOrder;
   }
 
+  /**
+   * Get additional query parameters.
+   *
+   * @return Map of parameter name to value
+   */
   public Map<String, Object> getParams() {
     return params;
   }
@@ -159,6 +199,12 @@ public static class FilterQueryBuilder {
 
     FilterQueryBuilder() {}
 
+    /**
+     * Set the filter expression.
+     *
+     * @param filterExpression The filter to apply
+     * @return this builder
+     */
     public FilterQueryBuilder filterExpression(Filter filterExpression) {
       this.filterExpression = filterExpression;
       return this;
@@ -175,21 +221,45 @@ public FilterQueryBuilder returnFields(List<String> returnFields) {
       return this;
     }
 
+    /**
+     * Set the number of results to return.
+     *
+     * @param numResults Maximum number of results
+     * @return this builder
+     */
     public FilterQueryBuilder numResults(int numResults) {
       this.numResults = numResults;
       return this;
     }
 
+    /**
+     * Set the query dialect.
+     *
+     * @param dialect RediSearch dialect version
+     * @return this builder
+     */
     public FilterQueryBuilder dialect(int dialect) {
       this.dialect = dialect;
       return this;
     }
 
+    /**
+     * Set the field to sort results by.
+     *
+     * @param sortBy Field name to sort by
+     * @return this builder
+     */
     public FilterQueryBuilder sortBy(String sortBy) {
       this.sortBy = sortBy;
       return this;
     }
 
+    /**
+     * Set whether to require in-order term matching.
+     *
+     * @param inOrder true to require terms in same order as query
+     * @return this builder
+     */
     public FilterQueryBuilder inOrder(boolean inOrder) {
       this.inOrder = inOrder;
       return this;
@@ -206,6 +276,11 @@ public FilterQueryBuilder params(Map<String, Object> params) {
       return this;
     }
 
+    /**
+     * Build the FilterQuery instance.
+     *
+     * @return A new FilterQuery with the configured parameters
+     */
     public FilterQuery build() {
       return new FilterQuery(this);
     }

core/src/main/java/com/redis/vl/query/HybridQuery.java

@@ -185,10 +185,20 @@ public static HybridQueryBuilder builder() {
 
   // Getters with defensive copies for mutable fields
 
+  /**
+   * Get the text query string.
+   *
+   * @return The text to search for
+   */
   public String getText() {
     return text;
   }
 
+  /**
+   * Get the text field name.
+   *
+   * @return The field name containing text data
+   */
   public String getTextFieldName() {
     return textFieldName;
   }
@@ -202,26 +212,56 @@ public float[] getVector() {
     return vector != null ? vector.clone() : null;
   }
 
+  /**
+   * Get the vector field name.
+   *
+   * @return The field name containing vector data
+   */
   public String getVectorFieldName() {
     return vectorFieldName;
   }
 
+  /**
+   * Get the text scoring algorithm.
+   *
+   * @return The text scorer (e.g., "BM25", "TFIDF")
+   */
   public String getTextScorer() {
     return textScorer;
   }
 
+  /**
+   * Get the filter expression.
+   *
+   * @return The filter to apply, or null if no filter
+   */
   public Filter getFilterExpression() {
     return filterExpression;
   }
 
+  /**
+   * Get the alpha weighting factor.
+   *
+   * @return Weight between 0.0 (vector only) and 1.0 (text only)
+   */
   public float getAlpha() {
     return alpha;
   }
 
+  /**
+   * Get the data type for vector storage.
+   *
+   * @return The data type (e.g., "float32", "float64")
+   */
   public String getDtype() {
     return dtype;
   }
 
+  /**
+   * Get the maximum number of results.
+   *
+   * @return The result limit
+   */
   public int getNumResults() {
     return numResults;
   }
@@ -244,6 +284,11 @@ public Set<String> getStopwords() {
     return Collections.unmodifiableSet(stopwords);
   }
 
+  /**
+   * Get the query dialect version.
+   *
+   * @return The dialect version (default 2)
+   */
   public int getDialect() {
     return dialect;
   }