summaryrefslogtreecommitdiff
path: root/src/main
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-05-10 15:35:21 +0100
committerMichael Williamson <mike@zwobble.org>2026-05-10 15:35:21 +0100
commitfe9d820d35bd3759d390593fc08ec241fbb21680 (patch)
tree2d087d84133eb52fa16dc0479e05825d60f96161 /src/main
parent4ecf8383268b2698bf4f81390da26898a6a5797f (diff)
Use docs comments in java-types output
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/org/zwobble/hobgoblin/compiler/output/generators/javatypes/JavaTypesGenerator.java6
-rw-r--r--src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/JavaWriter.java15
-rw-r--r--src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaClassDeclaration.java3
-rw-r--r--src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaInterfaceDeclaration.java3
-rw-r--r--src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaRecordDeclaration.java3
5 files changed, 25 insertions, 5 deletions
diff --git a/src/main/java/org/zwobble/hobgoblin/compiler/output/generators/javatypes/JavaTypesGenerator.java b/src/main/java/org/zwobble/hobgoblin/compiler/output/generators/javatypes/JavaTypesGenerator.java
index 3e12b8c..062fc9b 100644
--- a/src/main/java/org/zwobble/hobgoblin/compiler/output/generators/javatypes/JavaTypesGenerator.java
+++ b/src/main/java/org/zwobble/hobgoblin/compiler/output/generators/javatypes/JavaTypesGenerator.java
@@ -94,7 +94,8 @@ public class JavaTypesGenerator implements Generator {
field.name()
))
.toList(),
- javaClassToImplementsType.getOrDefault(structDefinition.name(), List.of())
+ javaClassToImplementsType.getOrDefault(structDefinition.name(), List.of()),
+ structDefinition.docComment()
)
);
@@ -108,7 +109,8 @@ public class JavaTypesGenerator implements Generator {
sumDefinition.name(),
sumDefinition.variants().stream()
.map(variant -> generateTypeRef(variant.type()))
- .toList()
+ .toList(),
+ sumDefinition.docComment()
)
);
diff --git a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/JavaWriter.java b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/JavaWriter.java
index c866ecd..fed544d 100644
--- a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/JavaWriter.java
+++ b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/JavaWriter.java
@@ -44,7 +44,18 @@ public class JavaWriter implements AutoCloseable {
}
}
+ private void writeDocComment(String docComment) throws IOException {
+ Iterable<String> lines = docComment.lines()::iterator;
+ for (var line : lines) {
+ this.writer.write("/// ");
+ this.writer.write(line);
+ this.writer.write("\n");
+ }
+ }
+
private void writeClassDeclaration(JavaClassDeclaration classDeclaration) throws IOException {
+ writeDocComment(classDeclaration.docComment());
+
this.writer.write("public class ");
this.writer.write(classDeclaration.name());
this.writer.write(" {");
@@ -83,6 +94,8 @@ public class JavaWriter implements AutoCloseable {
}
private void writeInterfaceDeclaration(JavaInterfaceDeclaration interfaceDeclaration) throws IOException {
+ writeDocComment(interfaceDeclaration.docComment());
+
this.writer.write("public sealed interface ");
this.writer.write(interfaceDeclaration.name());
this.writer.write(" ");
@@ -103,6 +116,8 @@ public class JavaWriter implements AutoCloseable {
}
private void writeRecordDeclaration(JavaRecordDeclaration recordDeclaration) throws IOException {
+ writeDocComment(recordDeclaration.docComment());
+
this.writer.write("public record ");
this.writer.write(recordDeclaration.name());
this.writer.write("(");
diff --git a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaClassDeclaration.java b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaClassDeclaration.java
index e7556a6..298e31f 100644
--- a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaClassDeclaration.java
+++ b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaClassDeclaration.java
@@ -4,6 +4,7 @@ import java.util.List;
public record JavaClassDeclaration(
String name,
- List<JavaClassBodyDeclaration> body
+ List<JavaClassBodyDeclaration> body,
+ String docComment
) implements JavaTypeDeclaration {
}
diff --git a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaInterfaceDeclaration.java b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaInterfaceDeclaration.java
index dfa20e9..2fe3a8d 100644
--- a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaInterfaceDeclaration.java
+++ b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaInterfaceDeclaration.java
@@ -4,6 +4,7 @@ import java.util.List;
public record JavaInterfaceDeclaration(
String name,
- List<JavaTypeRef> permitsTypes
+ List<JavaTypeRef> permitsTypes,
+ String docComment
) implements JavaTypeDeclaration {
}
diff --git a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaRecordDeclaration.java b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaRecordDeclaration.java
index 7dcda27..10b80a5 100644
--- a/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaRecordDeclaration.java
+++ b/src/main/java/org/zwobble/hobgoblin/compiler/output/lang/java/ast/JavaRecordDeclaration.java
@@ -5,6 +5,7 @@ import java.util.List;
public record JavaRecordDeclaration(
String name,
List<JavaRecordComponent> components,
- List<JavaTypeRef> implementsTypes
+ List<JavaTypeRef> implementsTypes,
+ String docComment
) implements JavaTypeDeclaration {
}