HTML JavaDocs issues

[Trigary]

There are multiple issues in the exported JavaDocs. Some of these are only present in builds by JitPack, some are also present locally. Let's use these methods as examples:

• https://javadoc.jitpack.io/com/github/Trigary/Iodine/api/master-c140a84bd6-1/javadoc/hu/trigary/iodine/api/IodineApi.html#getPlayer-java.util.UUID-
• https://javadoc.jitpack.io/com/github/Trigary/Iodine/api/master-c140a84bd6-1/javadoc/hu/trigary/iodine/api/IodineApi.html#isModded-java.util.UUID-

Issues on JitPack:

• the 2nd annotation (@Contract) has whitespace before it for no reason
• the method (the return value) is annotated as @NotNull twice
• the parameter is annotated as @NotNull twice
• there are unnecessary (and ugly) whitespace and a newline between the parameter's @NotNull annotations
• the IodinePlayer.State references are not resolved (build warning: Tag @link: reference not found: IodinePlayer.State)

Issues on local (my own PC):

• all annotations, parameters are on a single line: there are no linebreaks to improve readability
• the method (the return value) is annotated as @NotNull twice
• the parameter is annotated as @NotNull twice

This means that the only non-visual issue, the broken references, are not present locally and have something to do with JitPack's build process. They being broken must have something to do with the fact that they are references to inner classes.

The duplicate/double annotation issue is not unique to our case at all. Spigot, Paper and probably almost every other project also experiences it. Java Bug Database link: https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8175533

Thank you to Z750 and electroniccat from PaperMC for some insight regarding these issues.

[yannicklamprecht]

Is the javadoc generated by the javadoc-plugin fully valid? Just deploy it to GitHub.io environment instead.

[Trigary]

Not sure what you mean by fully valid. It works, but it has the problems described in the issue. I dislike the idea of manually publishing the JavaDocs, therefore GitHub pages is not an option.