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

Remove javadoc for overridden methods #4581

Closed
gregw opened this issue Feb 17, 2020 · 4 comments
Closed

Remove javadoc for overridden methods #4581

gregw opened this issue Feb 17, 2020 · 4 comments

Comments

@gregw
Copy link
Contributor

gregw commented Feb 17, 2020

There are many methods in the source that have javadoc like:

    /*
     * @see javax.servlet.SomeClass#someMethod()
     */
    @Override
    public Object someMethod()
    {
        ...
    }

We should remove all such empty javadoc as the @Override provides all the information needed.

@gregw
Copy link
Contributor Author

gregw commented Feb 17, 2020

@joakime @olamy @lachlan-roberts Do you have any awk/sed/scripting magic that can do this?

@joakime
Copy link
Contributor

joakime commented Feb 17, 2020

Not offhand, but I wonder if checkstyle (or some other tool) can detect javadoc that has no content like that?

lachlan-roberts added a commit that referenced this issue Feb 18, 2020
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
lachlan-roberts added a commit that referenced this issue Feb 18, 2020
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
@lachlan-roberts
Copy link
Contributor

I tried running a few different regex replaces through Intellij, I'll put a PR up and see how it looks.

lachlan-roberts added a commit that referenced this issue Feb 18, 2020
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
lachlan-roberts added a commit that referenced this issue Feb 18, 2020
Issue #4581 - remove unnecessary javadoc on Override methods
@lachlan-roberts
Copy link
Contributor

Fixed in jetty-10 with PR #4583.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants