Skip to content

Add support for Markdown javadoc#141

Draft
Juuxel wants to merge 9 commits into
FabricMC:devfrom
Juuxel:feature/markdown
Draft

Add support for Markdown javadoc#141
Juuxel wants to merge 9 commits into
FabricMC:devfrom
Juuxel:feature/markdown

Conversation

@Juuxel
Copy link
Copy Markdown
Member

@Juuxel Juuxel commented Apr 16, 2026

Adds support for MD comments using a new CommentStyle enum. All the old methods dealing with comments are assumed to use HTML, and new overloads of all methods have been added to support either CommentStyle.

The Enigma and Tiny v2 formats have a change to accommodate the Markdown javadoc. The Enigma marker for MD comments is MDCOMMENT instead of COMMENT, and the Tiny v2 marker is md instead of c.

# Enigma
CLASS Foo Bar
    MDCOMMENT Hello world

# Tiny
c Foo Bar
    md Hello world

When regenerating the test files, some other changes appeared that are unrelated to this PR. Not sure if they're something to fix later.


TODO:

  • Expand test coverage to cover all javadoc targets (class, field, method, arg, var)

Comment thread src/main/java/net/fabricmc/mappingio/format/enigma/EnigmaFileReader.java Outdated
Co-authored-by: Joseph Burton <burtonjae@hotmail.co.uk>
@Juuxel Juuxel marked this pull request as draft April 16, 2026 12:32
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

Successfully merging this pull request may close these issues.

2 participants