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

Various Javadoc fixes #5115

Merged
merged 1 commit into from
Jun 24, 2022
Merged

Various Javadoc fixes #5115

merged 1 commit into from
Jun 24, 2022

Conversation

Emkas
Copy link
Contributor

@Emkas Emkas commented Jun 16, 2022

  • Removed empty @return
  • Fixed broken links
  • Removed broken and badly placed Javadoc
  • Corrected @throws declarations
  • @param before @throws

* Removed empty @return
* Fixed broken links
* Removed broken and badly placed Javadoc
* Corrected @throws declarations
* @param before @throws

Signed-off-by: Emil Sierżęga <emilsierzega@gmail.com>
@melloware
Copy link
Contributor

Thank you for all these PR's cleaning up!

@Emkas
Copy link
Contributor Author

Emkas commented Jun 16, 2022

Thank you for all these PR's cleaning up!

You're all welcome :-) I've got many more of it.

When I've imported this project to eclipse I saw a sea of various warnings (more than 2k). And I don't like that :-) Mostly they are about raw types. Lack of them creates a space where there are test that are basically checking if raw types in Java works (like fail(Should have thrown ClassCastException)). I suspect that this is because the roots of the project remembers Java 4.

But I need more time on this, since I need to figure out which changes concert api and which are internal. I want to touch only the second ones. (And I hope that tests coverage in this project is good enough :-) Since I base mostly on them.)

@arjantijms
Copy link
Contributor

When I've imported this project to eclipse I saw a sea of various warnings (more than 2k).

That's true. We've been addressing a number of them throughout the years, but there's more to be done as you noticed. If you really want to see a lot of those, just take a look at the 2.2 version of the sources :O

@arjantijms
Copy link
Contributor

And I hope that tests coverage in this project is good enough

There's a large number of tests indeed, but we moved them to the jakarta/faces project. It are nearly 6000, and they take some 2 hours to run.

@Emkas
Copy link
Contributor Author

Emkas commented Jun 16, 2022

There's a large number of tests indeed, but we moved them to the jakarta/faces project. It are nearly 6000, and they take some 2 hours to run.

Great! Lesser chance that I'll break something.

For now I get rid of about half of the warnings, but not all of them are as trivial as I thought in the first glance :-)

@BalusC BalusC merged commit fa7f65c into eclipse-ee4j:master Jun 24, 2022
@Emkas Emkas deleted the javadoc-fixes branch June 24, 2022 14:10
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.

4 participants