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
Retire all Javadoc author tags #1664
Comments
I'll have a look at it in the frame of an update of code style checkers and also add the @author tag to the set of checkstyle rules. Gradle 2.4 should bring a few niceties for improved integration and I might want to wait for it to be released. This should be the next 1-2 weeks, I hope. |
Sounds good, no rush :) |
Started looking at module javadoc some thinking maybe I could fix up a few modules real quick, switch them to Java 8 in Jenkins, then run good builds so we can have working binary releases again ... but I may be underestimating the amount of errors :D I just started with a search for @author in *.java under modules in my mega-workspace and fixed 136 hits across AnotherWorld, BlockNetwork, Breathing, and Cities. But that didn't count other javadoc errors ;-) It is a bit of a hassle to detect them too, takes forever if using gradlew javadoc on a particular module. Wonder if Checkstyle could catch it all specifically to make it easier to fix. I'm probably missing other easy options. Just to get a list somewhere here are the modules in the lineup with author tags (about 500 file hits, not counting what I've got fixed locally):
and other libraries:
|
I just noticed Gradle 2.4 adds an ability to replace external dependencies with project dependencies, woo! That's what I've hacked in presently. That'll be nice to clean up - that release could indeed be sweet :-) |
Temp hack in place to let the module builds work: e328c4a Includes a TODO to remove it again later, since you know that always ensures that it does in fact get removed later ... Jenkins should log the warnings + errors so at least they'll be easy to spot, although I'm sure there's a better way in IDEs |
I tried to configure CheckStyle to flag |
Unfortunately, my assumption was confirmed and we need to find a workaround such as plain RegEx to make CheckStyle flag the remaining |
I think that we can close this issue, since all MovingBlocks repositories have been updated. |
Agreed! And we have warnings being issued for them now too, thanks for that :-) |
As discussed in the forum: http://forum.terasology.org/threads/removal-of-all-javadoc-author-tags-any-objections.1273/
No objections so far, so if anybody wants to get it over with doooo eeeet :-)
We probably should also look at Javadoc in modules, lest we forget and have them break when updated to Java 8.
The text was updated successfully, but these errors were encountered: