github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[jOOQ/jOOQ#17928] Generated Javadoc should reference qualified output name of generated objects, not input name

Browse Source
This commit is contained in:
Lukas Eder 2025-01-31 12:58:30 +01:00
parent 695151320b
commit 37d93db16f
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
jOOQ-codegen/src/main/java/org/jooq/codegen/JavaGenerator.java
View File

@ -3298,7 +3298,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnTables())
printClassJavadoc(out, table);
else
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedOutputName() + "</code>.");
}
/**
@ -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 <code>" + embeddable.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, embeddable, "The embeddable <code>" + embeddable.getQualifiedOutputName() + "</code>.");
}
private String refRowType(JavaWriter out, Collection<? extends Definition> columns) {
@ -3607,7 +3607,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnTables())
printClassJavadoc(out, table);
else
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedOutputName() + "</code>.");
}
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 <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedOutputName() + "</code>.");
}
@SuppressWarnings("unused")
@ -3970,7 +3970,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnUDTs())
printClassJavadoc(out, udt);
else
printClassJavadoc(out, udt, "The udt path for <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt path for <code>" + udt.getQualifiedOutputName() + "</code>.");
}
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 <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedOutputName() + "</code>.");
}
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 <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedOutputName() + "</code>.");
}
/**
@ -4066,7 +4066,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnUDTs())
printClassJavadoc(out, udt);
else
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedOutputName() + "</code>.");
}
/**
@ -4101,7 +4101,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnUDTs())
printClassJavadoc(out, udt);
else
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, udt, "The udt <code>" + udt.getQualifiedOutputName() + "</code>.");
}
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 <code>" + array.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, array, "The type <code>" + array.getQualifiedOutputName() + "</code>.");
}
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 <code>" + e.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, e, "The enum <code>" + e.getQualifiedOutputName() + "</code>.");
}
/**
@ -5218,7 +5218,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnTables())
printClassJavadoc(out, dao);
else
printClassJavadoc(out, dao, "The synthetic DAO <code>" + dao.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, dao, "The synthetic DAO <code>" + dao.getQualifiedOutputName() + "</code>.");
}
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 <code>" + table.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedOutputName() + "</code>.");
}
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 <code>" + table.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedOutputName() + "</code>.");
}
protected void generateTables(SchemaDefinition schema) {
@ -7992,8 +7992,8 @@ public class JavaGenerator extends AbstractGenerator {
}
out.javadoc(
"Get the implicit join path to the <code>" + foreignKey.getReferencedTable().getQualifiedName() + "</code> table"
+ (pathCounts.get(foreignKey.getReferencedTable()) > 1 ? ", via the <code>" + foreignKey.getInputName() + "</code> key" : "")
"Get the implicit join path to the <code>" + foreignKey.getReferencedTable().getQualifiedOutputName() + "</code> table"
+ (pathCounts.get(foreignKey.getReferencedTable()) > 1 ? ", via the <code>" + foreignKey.getOutputName() + "</code> key" : "")
+ "."
);
@ -8068,8 +8068,8 @@ public class JavaGenerator extends AbstractGenerator {
}
out.javadoc(
"Get the implicit to-many join path to the <code>" + foreignKey.getReferencingTable().getQualifiedName() + "</code> table"
+ (pathCounts.get(foreignKey.getReferencingTable()) > 1 ? ", via the <code>" + foreignKey.getInputName() + "</code> key" : "")
"Get the implicit to-many join path to the <code>" + foreignKey.getReferencingTable().getQualifiedOutputName() + "</code> table"
+ (pathCounts.get(foreignKey.getReferencingTable()) > 1 ? ", via the <code>" + foreignKey.getOutputName() + "</code> key" : "")
);
if (scala) {
@ -8131,8 +8131,8 @@ public class JavaGenerator extends AbstractGenerator {
);
out.javadoc(
"Get the implicit many-to-many join path to the <code>" + referencedTable.getQualifiedName() + "</code> table"
+ (pathCountsManytoMany.get(referencedTable) > 1 ? ", via the <code>" + manyToManyKey.getInputName() + "</code> key" : "")
"Get the implicit many-to-many join path to the <code>" + referencedTable.getQualifiedOutputName() + "</code> table"
+ (pathCountsManytoMany.get(referencedTable) > 1 ? ", via the <code>" + manyToManyKey.getOutputName() + "</code> key" : "")
);
if (scala) {
@ -8838,7 +8838,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnEmbeddables())
printClassJavadoc(out, embeddable);
else
printClassJavadoc(out, embeddable, "The embeddable <code>" + embeddable.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, embeddable, "The embeddable <code>" + embeddable.getQualifiedOutputName() + "</code>.");
}
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 <code>" + embeddable.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, embeddable, "The embeddable <code>" + embeddable.getQualifiedOutputName() + "</code>.");
}
private String converterTemplate(List<String> converter) {
@ -9026,7 +9026,7 @@ public class JavaGenerator extends AbstractGenerator {
if (generateCommentsOnTables())
printClassJavadoc(out, table);
else
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, table, "The table <code>" + table.getQualifiedOutputName() + "</code>.");
}
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 <code>" + catalog.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, catalog, "The catalog <code>" + catalog.getQualifiedOutputName() + "</code>.");
}
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 <code>" + schema.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, schema, "The schema <code>" + schema.getQualifiedOutputName() + "</code>.");
}
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 <code>" + routine.getQualifiedInputName() + "</code>.");
printClassJavadoc(out, routine, "The routine <code>" + routine.getQualifiedOutputName() + "</code>.");
}
protected void printConvenienceMethodFunctionAsField(JavaWriter out, RoutineDefinition function, boolean parametersAsField) {