kriegaex commented on PR #204:
URL: 
https://github.com/apache/maven-javadoc-plugin/pull/204#issuecomment-1821952458

   > All other plugins with subdirs have fixed names, you can only control the 
output directory
   
   That might be so. I neither know nor use all plugins. But at least, for 
Javadoc and JXR it currently is possible to change that. Generally, I agree 
that most people will just use defaults for the destination directories 
(destDirs, I mean the last part of the final directory path), but we have no 
way of knowing, because in many cases they do not have a choice. I also find it 
unfortunate that the destDir names are fixed, and many of them I do not like. 
On the one hand, one could argue that this is just cosmetics. On the other 
hand, IMO it is suboptimal that a bunch of Maven plugins feel entitled to just 
usurp those directory "namespaces". For instance, I would prefer "javadocs" to 
"apidocs", "unit-test-reports" to "surefire-reports" and 
"integration-test-reports" to "failsafe-reports".
   
   Having said that, I acknowledge that the current state of affairs, though 
suboptimal, is certainly something I can live with. Arguably, it might be out 
of scope of this PR to change it.
   
   > everything else is at the discretion of the plugin (...) I wonder whether 
there is a real world usecase to change `apidocs` to something else
   
   Yes, other plugins outside the set of Maven core plugins offer the option to 
change destDirs, and I rather like it. One such example is the plugin I was 
working one when we got this whole avalanche here rolling: AspectJ Maven 
Plugin. Actually, the AspectJ report uses original javadocs as an import and 
decorates them with additional information about which aspects affect which 
classes/methods and vice versa. In this regard, the AspectJ Maven report 
replaces Maven Javadoc report, i.e. some users might like the option to change 
the default destDir "aspectj-report" to "apidocs" to further document that 
fact. They can do that, because the plugin permits them to do it. If for 
whatever reason the user also redundantly wants to generate the original 
javadocs, in the future he could not rename "apidocs" to "apidocs-orig" or 
whatever. That is by no means a big deal, I just meant to provide an example.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to