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

Fixing MegaMekLab's Javadoc Build #1028

Merged
merged 1 commit into from
Feb 19, 2022

Conversation

Windchild292
Copy link
Contributor

This continues on from MegaMek/megamek#3445 to fix the Javadoc build for MegaMekLab.

Akin to the previous one, there are still huge gaps in our Javadoc coverages, and tons of warnings.

Copy link
Member

@SJuliez SJuliez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All ok. I must say though that I find it greatly unappealing to always use @return and @param instead of real language and fail to see any advantage. In other words I am not aware that I was missing anything and so rather unwilling to change my comment practice.

@Windchild292
Copy link
Contributor Author

It's for Javadoc parsing, as it creates the return and parameters setup in the Javadoc build. See below for an image showing why you want to use @param and @return.
image

@Windchild292 Windchild292 merged commit 2a90304 into MegaMek:master Feb 19, 2022
@Windchild292 Windchild292 deleted the dev_Windchild_Javadoc branch February 19, 2022 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants