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

Support for Markdown comments in mappings #106

Open
7 tasks
Juuxel opened this issue Aug 22, 2024 · 0 comments
Open
7 tasks

Support for Markdown comments in mappings #106

Juuxel opened this issue Aug 22, 2024 · 0 comments

Comments

@Juuxel
Copy link
Member

Juuxel commented Aug 22, 2024

Java 23 will be adding Markdown javadoc comments (JEP 467). They use a different comment style (///) compared to the traditional HTML comments (/** */), so they'll need special support across the toolchain.

  • Support in mappings
    • mapping-io API for Markdown comments
      • CommentStyle enum with HTML and MARKDOWN?
    • Tiny format support
      • Might need Tiny 2.1
      • md instead of c?
    • Enigma format support
      • Example: MDCOMMENT instead of COMMENT
  • Support in Enigma (the app, possibly also the old mapping reader/writer)
  • Support in javapoet
  • Support in decompilers for the new comment style
    • Especially Vineflower and Fabric's CFR and Fernflower forks
  • Support in Loom
    • Essentially bridging all this together
  • We could also try to convert the MD comments to HTML to support them early in decompilers etc
    • Converters: Pandoc or a Java library like flexmark or commonmark-java (the last one is used in the JDK for the conversion)
    • Needs to work with the extensions like GFM tables or javadoc tags
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant