Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate markdown-formatted javadoc #134

Open
jwharm opened this issue Aug 31, 2024 · 0 comments
Open

Generate markdown-formatted javadoc #134

jwharm opened this issue Aug 31, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jwharm
Copy link
Owner

jwharm commented Aug 31, 2024

Gtk API documentation (gi-docgen) is in markdown format. To generate clean-looking Javadoc, java-gi runs a series of regular expressions to translate markdown formatting to HTML. This works well enough in many cases, but some formatting, like tables, are not translated.

With JEP 467, OpenJDK 23 introduces markdown-formatted Javadoc. This would be a natural fit for java-gi. However, there are two disadvantages:

  • JavaPoet doesn't support newer JDK features, and has been in maintenance mode with no new releases planned. So it will probably need to be forked to generate the new Javadoc syntax.
  • This will raise the minimum required Java version to OpenJDK 23. All users will have to upgrade.
@jwharm jwharm added enhancement New feature or request documentation Improvements or additions to documentation labels Aug 31, 2024
@jwharm jwharm removed the documentation Improvements or additions to documentation label Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant