From cebf288b8cb955a9c2f6fc0c831ffeeaaecb7453 Mon Sep 17 00:00:00 2001 From: Stefan Bischof Date: Sat, 4 Jul 2026 14:41:07 +0200 Subject: [PATCH] fix(docs): update Javadoc for clarity and formatting Signed-off-by: Stefan Bischof --- .../daanse/sql/statement/api/exec/StatementExecutor.java | 2 +- .../daanse/sql/statement/api/expression/SqlExpression.java | 3 ++- .../eclipse/daanse/sql/statement/api/render/RenderOptions.java | 3 +++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/exec/StatementExecutor.java b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/exec/StatementExecutor.java index 137f956..65f7691 100644 --- a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/exec/StatementExecutor.java +++ b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/exec/StatementExecutor.java @@ -20,7 +20,7 @@ /** * Executes already-rendered SQL and maps result rows. This is the adaptable - * seam: the JDBC implementation is {@link JdbcStatementExecutor}, but other + * seam: the JDBC implementation is {@code JdbcStatementExecutor}, but other * backends (a test double, a remote service, a cached source) can implement the * same contract. */ diff --git a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/expression/SqlExpression.java b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/expression/SqlExpression.java index 99970c0..b514bc4 100644 --- a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/expression/SqlExpression.java +++ b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/expression/SqlExpression.java @@ -101,7 +101,8 @@ record Aggregate(String name, boolean distinct, List arguments) i } /** - * A portable well-known function call, identified by {@link KnownFunction} + * A portable well-known function call, identified by + * {@link org.eclipse.daanse.jdbc.db.dialect.api.generator.KnownFunction KnownFunction} * intent rather than a verbatim function name — the dialect's * {@code FunctionGenerator} chooses the spelling at render time (e.g. * {@code LENGTH} renders as {@code CHAR_LENGTH(x)} on ANSI but {@code LEN(x)} diff --git a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/render/RenderOptions.java b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/render/RenderOptions.java index 9ea7782..e180a45 100644 --- a/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/render/RenderOptions.java +++ b/statement/api/src/main/java/org/eclipse/daanse/sql/statement/api/render/RenderOptions.java @@ -22,6 +22,9 @@ * statement nodes (a header comment, per-column and per-join * comments). Defaults to {@code false}; the executed SQL is * rendered with comments off so it stays byte-identical. + * @param commentStyle how comments are spelled when {@code comments} is on: + * {@code LINE} ({@code -- ...} on its own line) or + * {@code BLOCK} (inline {@code /* ... *}{@code /}). */ public record RenderOptions(boolean formatted, String indent, boolean comments, CommentStyle commentStyle) {