[MCOMPILER-428] Documentation regarding useIncrementalCompilation not very useful

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.9.0
• Labels: documentation
• Flags: Patch
• Assignee: Robert Scholte
• Reporter: Thomas Bracher
• Created: 24/Aug/20 16:15
• Updated: 12/Mar/21 18:56
• Resolved: 12/Mar/21 18:42

Description

As of today, maven-compiler-plugin documentation for useIncrementalCompilation says: "to enable/disable incrementation compilation feature". Since there is no documentation of said feature, users will have to either:

1) take a guess at how the feature behaves
2) painfully read the plugin code to understand what it does

This is less than optimal and lead to misunderstanding, like this comment https://issues.apache.org/jira/browse/MCOMPILER-205?focusedCommentId=14428972&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-14428972

So far the most explicit documentation I have found is in answer of a stackoverflow issue: https://stackoverflow.com/a/49700942

I think it would benefit a lot of users to understand the implication of both options of this flag. I am trying to submit a PR providing an example of text.

Issue Links

• links to: GitHub Pull Request #34