[jira] [Commented] (MCOMPILER-428) Documentation regarding useIncrementalCompilation not very useful

["Thomas Bracher (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MCOMPILER-428?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17268035#comment-17268035 ] 

Thomas Bracher commented on MCOMPILER-428:
------------------------------------------

I feel like this PR is under the radar. If anyone has time to check it again, that'll be much appreciated!

> Documentation regarding useIncrementalCompilation not very useful
> -----------------------------------------------------------------
>
>                 Key: MCOMPILER-428
>                 URL: https://issues.apache.org/jira/browse/MCOMPILER-428
>             Project: Maven Compiler Plugin
>          Issue Type: Improvement
>            Reporter: Thomas Bracher
>            Priority: Minor
>              Labels: documentation
>
> 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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)