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: Improve Javadoc quality in Environment interface #3968

Merged
merged 2 commits into from
May 31, 2021

Conversation

slarse
Copy link
Collaborator

@slarse slarse commented May 28, 2021

#3923

The Environment interface is arguably one of the most important ones in the entire Spoon library, and it's fairly underdocumented. This PR improves the documentation by adding all missing @param and @return tags, fixing errors and adding missing explanations of what things actually do.

Javadoc method quality score increases like so:

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

There are still improvements to be made here, especially in explaining what the options you can set actually do, but I felt like this was enough for a single PR.

@slarse slarse changed the title doc: Improve docs in Environment interface doc: Improve Javadoc quality in Environment interface May 28, 2021
@slarse slarse changed the title doc: Improve Javadoc quality in Environment interface review: doc: Improve Javadoc quality in Environment interface May 28, 2021
Co-authored-by: andrewbwogi <[email protected]>
@monperrus monperrus changed the title review: doc: Improve Javadoc quality in Environment interface doc: Improve Javadoc quality in Environment interface May 31, 2021
@monperrus monperrus merged commit 719cdc2 into INRIA:master May 31, 2021
@monperrus
Copy link
Collaborator

We ❤️ documentation PR. Thanks Simon.

@slarse slarse deleted the issue/3923-improve-docs-in-Environment branch May 31, 2021 09:04
@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.

3 participants