Upgrade to JDK 25, use JavaPoet fork, generate Markdown Javadoc #335
No reviewers
Labels
No labels
bug
dependencies
documentation
duplicate
enhancement
github_actions
good first issue
help wanted
invalid
java
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
java-gi/java-gi!335
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "md-javadoc"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
GObject-Introspection API documentation is usually formatted with Markdown. Since JDK 23 (JEP 467) this is also possible in Javadoc. This simplifies Java-GI's documentation converter and allows for some formatting constructs that not implemented in the md->html conversion, such as tables.
Until now, Java-GI still built JDK 22 versioned artifacts to not break compatibility for no reason. Instead of upgrading to JDK 23 for JEP 467, we move to the current (and LTS) version 25.
Because upstream square's JavaPoet is unmaintained and didn't support JEP 467, I forked it: https://codeberg.org/java-gi/javapoet
The forked JavaPoet can generate Markdown javadoc with an option on the JavaFile class. The fork is included in the java-gi git repository as a submodule.
The switch to Markdown Javadoc is mostly a change in the Javadoc class. The javadoc for literally-generated methods has also been updated.