Skip to content

Commit

Permalink
Config Doc - Prepare the arrival of Markdown
Browse files Browse the repository at this point in the history
For IDEs, we will need to be able to convert our javadoc to Markdown.
And obviously, transforming our javadoc to Asciidoc right in the
generated YAML files is a bad idea.
We now pass the raw Javadoc and it is going to be transformed at a later
stage.
  • Loading branch information
gsmet committed Sep 10, 2024
1 parent ac75ce9 commit b5e35cd
Show file tree
Hide file tree
Showing 20 changed files with 632 additions and 449 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,12 @@ public void finalizeProcessing() {

Properties javadocProperties = new Properties();
for (Entry<String, JavadocElement> javadocElementEntry : configCollector.getJavadocElements().entrySet()) {
javadocProperties.put(javadocElementEntry.getKey(), javadocElementEntry.getValue().rawJavadoc());
if (javadocElementEntry.getValue().description() == null
|| javadocElementEntry.getValue().description().isBlank()) {
continue;
}

javadocProperties.put(javadocElementEntry.getKey(), javadocElementEntry.getValue().description());
}
utils.filer().write(Outputs.META_INF_QUARKUS_JAVADOC, javadocProperties);

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
package io.quarkus.annotation.processor.documentation.config.discovery;

public record ParsedJavadoc(String description, String since, String deprecated,
String originalDescription, JavadocFormat originalFormat) {
import io.quarkus.annotation.processor.documentation.config.model.JavadocFormat;

public record ParsedJavadoc(String description, JavadocFormat format, String since, String deprecated) {

public static ParsedJavadoc empty() {
return new ParsedJavadoc(null, null, null, null, null);
return new ParsedJavadoc(null, null, null, null);
}

public boolean isEmpty() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package io.quarkus.annotation.processor.documentation.config.discovery;

public record ParsedJavadocSection(String title, String details, String deprecated) {
import io.quarkus.annotation.processor.documentation.config.model.JavadocFormat;

public record ParsedJavadocSection(String title, String details, JavadocFormat format, String deprecated) {

public static ParsedJavadocSection empty() {
return new ParsedJavadocSection(null, null, null);
return new ParsedJavadocSection(null, null, null, null);
}
}
Loading

0 comments on commit b5e35cd

Please sign in to comment.