From 37d93db16fca0f3167b85f7a9f029db3cb50d062 Mon Sep 17 00:00:00 2001 From: Lukas Eder Date: Fri, 31 Jan 2025 12:58:30 +0100 Subject: [PATCH] [jOOQ/jOOQ#17928] Generated Javadoc should reference qualified output name of generated objects, not input name --- .../java/org/jooq/codegen/JavaGenerator.java | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/jOOQ-codegen/src/main/java/org/jooq/codegen/JavaGenerator.java b/jOOQ-codegen/src/main/java/org/jooq/codegen/JavaGenerator.java index 663b677f7d..4f61cd87fd 100644 --- a/jOOQ-codegen/src/main/java/org/jooq/codegen/JavaGenerator.java +++ b/jOOQ-codegen/src/main/java/org/jooq/codegen/JavaGenerator.java @@ -3298,7 +3298,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, table); else - printClassJavadoc(out, table, "The table " + table.getQualifiedInputName() + "."); + printClassJavadoc(out, table, "The table " + table.getQualifiedOutputName() + "."); } /** @@ -3311,7 +3311,7 @@ public class JavaGenerator extends AbstractGenerator { * Subclasses may override this method to provide their own Javadoc. */ protected void generateEmbeddableClassJavadoc(EmbeddableDefinition embeddable, JavaWriter out) { - printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedInputName() + "."); + printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedOutputName() + "."); } private String refRowType(JavaWriter out, Collection columns) { @@ -3607,7 +3607,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, table); else - printClassJavadoc(out, table, "The table " + table.getQualifiedInputName() + "."); + printClassJavadoc(out, table, "The table " + table.getQualifiedOutputName() + "."); } protected void generateUDTs(SchemaDefinition schema) { @@ -3835,7 +3835,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt " + udt.getQualifiedOutputName() + "."); } @SuppressWarnings("unused") @@ -3970,7 +3970,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt path for " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt path for " + udt.getQualifiedOutputName() + "."); } protected void generateUDTPojos(SchemaDefinition schema) { @@ -4001,7 +4001,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt " + udt.getQualifiedOutputName() + "."); } protected void generateUDTInterfaces(SchemaDefinition schema) { @@ -4032,7 +4032,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt " + udt.getQualifiedOutputName() + "."); } /** @@ -4066,7 +4066,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt " + udt.getQualifiedOutputName() + "."); } /** @@ -4101,7 +4101,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, udt); else - printClassJavadoc(out, udt, "The udt " + udt.getQualifiedInputName() + "."); + printClassJavadoc(out, udt, "The udt " + udt.getQualifiedOutputName() + "."); } protected void generateUDTRoutines(SchemaDefinition schema) { @@ -4470,7 +4470,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, array); else - printClassJavadoc(out, array, "The type " + array.getQualifiedInputName() + "."); + printClassJavadoc(out, array, "The type " + array.getQualifiedOutputName() + "."); } protected void generateEnums(SchemaDefinition schema) { @@ -4715,7 +4715,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnUDTs()) printClassJavadoc(out, e); else - printClassJavadoc(out, e, "The enum " + e.getQualifiedInputName() + "."); + printClassJavadoc(out, e, "The enum " + e.getQualifiedOutputName() + "."); } /** @@ -5218,7 +5218,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, dao); else - printClassJavadoc(out, dao, "The synthetic DAO " + dao.getQualifiedInputName() + "."); + printClassJavadoc(out, dao, "The synthetic DAO " + dao.getQualifiedOutputName() + "."); } protected void generateDaos(SchemaDefinition schema) { @@ -5858,7 +5858,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, table); else - printClassJavadoc(out, table, "The table " + table.getQualifiedInputName() + "."); + printClassJavadoc(out, table, "The table " + table.getQualifiedOutputName() + "."); } protected void generatePojos(SchemaDefinition schema) { @@ -7173,7 +7173,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, table); else - printClassJavadoc(out, table, "The table " + table.getQualifiedInputName() + "."); + printClassJavadoc(out, table, "The table " + table.getQualifiedOutputName() + "."); } protected void generateTables(SchemaDefinition schema) { @@ -7992,8 +7992,8 @@ public class JavaGenerator extends AbstractGenerator { } out.javadoc( - "Get the implicit join path to the " + foreignKey.getReferencedTable().getQualifiedName() + " table" - + (pathCounts.get(foreignKey.getReferencedTable()) > 1 ? ", via the " + foreignKey.getInputName() + " key" : "") + "Get the implicit join path to the " + foreignKey.getReferencedTable().getQualifiedOutputName() + " table" + + (pathCounts.get(foreignKey.getReferencedTable()) > 1 ? ", via the " + foreignKey.getOutputName() + " key" : "") + "." ); @@ -8068,8 +8068,8 @@ public class JavaGenerator extends AbstractGenerator { } out.javadoc( - "Get the implicit to-many join path to the " + foreignKey.getReferencingTable().getQualifiedName() + " table" - + (pathCounts.get(foreignKey.getReferencingTable()) > 1 ? ", via the " + foreignKey.getInputName() + " key" : "") + "Get the implicit to-many join path to the " + foreignKey.getReferencingTable().getQualifiedOutputName() + " table" + + (pathCounts.get(foreignKey.getReferencingTable()) > 1 ? ", via the " + foreignKey.getOutputName() + " key" : "") ); if (scala) { @@ -8131,8 +8131,8 @@ public class JavaGenerator extends AbstractGenerator { ); out.javadoc( - "Get the implicit many-to-many join path to the " + referencedTable.getQualifiedName() + " table" - + (pathCountsManytoMany.get(referencedTable) > 1 ? ", via the " + manyToManyKey.getInputName() + " key" : "") + "Get the implicit many-to-many join path to the " + referencedTable.getQualifiedOutputName() + " table" + + (pathCountsManytoMany.get(referencedTable) > 1 ? ", via the " + manyToManyKey.getOutputName() + " key" : "") ); if (scala) { @@ -8838,7 +8838,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnEmbeddables()) printClassJavadoc(out, embeddable); else - printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedInputName() + "."); + printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedOutputName() + "."); } protected void generateEmbeddableInterfaces(SchemaDefinition schema) { @@ -8869,7 +8869,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnEmbeddables()) printClassJavadoc(out, embeddable); else - printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedInputName() + "."); + printClassJavadoc(out, embeddable, "The embeddable " + embeddable.getQualifiedOutputName() + "."); } private String converterTemplate(List converter) { @@ -9026,7 +9026,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnTables()) printClassJavadoc(out, table); else - printClassJavadoc(out, table, "The table " + table.getQualifiedInputName() + "."); + printClassJavadoc(out, table, "The table " + table.getQualifiedOutputName() + "."); } protected void generateSequences(SchemaDefinition schema) { @@ -9585,7 +9585,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnCatalogs()) printClassJavadoc(out, catalog); else - printClassJavadoc(out, catalog, "The catalog " + catalog.getQualifiedInputName() + "."); + printClassJavadoc(out, catalog, "The catalog " + catalog.getQualifiedOutputName() + "."); } protected void generateSchema(SchemaDefinition schema) { @@ -9770,7 +9770,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnSchemas()) printClassJavadoc(out, schema); else - printClassJavadoc(out, schema, "The schema " + schema.getQualifiedInputName() + "."); + printClassJavadoc(out, schema, "The schema " + schema.getQualifiedOutputName() + "."); } protected void printFromAndInto(JavaWriter out, TableDefinition table) { @@ -10638,7 +10638,7 @@ public class JavaGenerator extends AbstractGenerator { if (generateCommentsOnRoutines()) printClassJavadoc(out, routine); else - printClassJavadoc(out, routine, "The routine " + routine.getQualifiedInputName() + "."); + printClassJavadoc(out, routine, "The routine " + routine.getQualifiedOutputName() + "."); } protected void printConvenienceMethodFunctionAsField(JavaWriter out, RoutineDefinition function, boolean parametersAsField) {