ParchmentMC / Feather

Library for common data objects used by ParchmentMC projects.
MIT License
4 stars 6 forks source link

Change `ParameterData#getJavadoc` to return a list of strings #6

Open sciwhiz12 opened 2 years ago

sciwhiz12 commented 2 years ago

Currently, MappingDataContainer.ParameterData#getJavadoc returns a single String. This precludes the possibility of multi-line javadocs for parameters, which is certainly possible both by javadoc and Enigma, the current mapping interface tool used by Parchment.

I plan to change that method to return a List<String> instead, to support the possibility of multi-line javadocs for parameters officially. This has the following consequences:

I will also look over the codebase for any API-breaking changes which can get rolled into the 2.0.0 version update.

NebelNidas commented 10 months ago

Why not take the Tiny v2 route and simply embed an escaped line break into the single string?