Maptool: Javadoc warnings cleanup

Created on 2 Feb 2020  路  6Comments  路  Source: RPTools/maptool

Describe the bug
Generating Javadoc causes so many warnings about bad/missing tags.

To Reproduce
gradlew javadoc

Expected behavior
Warnings should be eliminated.
sure the Javadoc is not in the greatest state at the moment, but it's easier to get people to add Javadoc to new functionality if generating it doesn't cause so many issues to be reported.

bug code maintenance tested

Most helpful comment

I started to look into this issue to understand how the tooling of maptool works today. Ending up removing all warnings with not to big effort.

All 6 comments

If the following is added to gradle:

options.addStringOption('Xmaxwarns', '2000')

then the current number of javadoc warnings is reported to be 399.

then the current number of javadoc warning is reported to be 399.

That means I am just over 1/4 of the way through fixing the warnings :(

I started to look into this issue to understand how the tooling of maptool works today. Ending up removing all warnings with not to big effort.

Awesome! Thank you so much for this! I'm only getting 6 warnings now:

javadoc: warning - invalid usage of tag &threadID
javadoc: warning - invalid usage of tag &start
javadoc: warning - invalid usage of tag &threadID
javadoc: warning - invalid usage of tag &start
javadoc: warning - invalid usage of tag &threadID
javadoc: warning - invalid usage of tag &start

Awesome! Thank you so much for this! I'm only getting 6 warnings now:

javadoc: warning - invalid usage of tag &threadID
javadoc: warning - invalid usage of tag &start

I or rather IntelliJ thinks that ScrollableFlowPanel, where this issue is can be deleted, the links to http://forum.java.sun.com/thread.jspa?forumID=57&threadID=701797&start=2 are broken as well. I guess the forum has moved, and or is closed.

Tested. JavaDocs generate without errors/warnings.

Was this page helpful?
0 / 5 - 0 ratings