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

doc: Add missing Javadoc tags to documented public methods in CtScanner #3934

Merged

Conversation

slarse
Copy link
Collaborator

@slarse slarse commented May 20, 2021

#3923

This PR adds 11 @param tags to existing Javadoc comments in CtScanner, improving the Javadoc quality score for the project by 11.

JAVADOC QUALITY SCORE (lower is better)
    Compare: 2652
    Current: 2641

All existing javadoc in CtScanner are now up-to-snuff, but there are still a lot of undocumented public methods (which is not the concern of #3923).

@slarse slarse changed the title doc: Add missing Javadoc tags to documented public methods in CtScanner review: doc: Add missing Javadoc tags to documented public methods in CtScanner May 20, 2021
@monperrus monperrus changed the title review: doc: Add missing Javadoc tags to documented public methods in CtScanner doc: Add missing Javadoc tags to documented public methods in CtScanner May 20, 2021
@monperrus monperrus merged commit d359662 into INRIA:master May 20, 2021
@monperrus
Copy link
Collaborator

We love doc PR!

@slarse slarse deleted the issue/3923-fix-CtScanner-method-javadoc branch May 20, 2021 17:36
@monperrus monperrus mentioned this pull request Aug 19, 2021
woutersmeenk pushed a commit to woutersmeenk/spoon that referenced this pull request Aug 29, 2021
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.

2 participants