jwharm / java-gi

GObject-Introspection bindings generator for Java
GNU Lesser General Public License v2.1
84 stars 7 forks source link

Generate markdown-formatted javadoc #134

Open jwharm opened 1 month ago

jwharm commented 1 month ago

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: