doc: Improve Javadoc quality in Environment interface #3968
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#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:
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.