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

Benson Margulies commented on BEAM-475:
---------------------------------------

https://github.com/apache/beam/pull/1781 

This exercise in duplication of information results from two apparent 
maven-javadoc-plugin bugs.

First, the aggregate goal seems completely broken when used in the lifecycle. 
The plugin has no integration tests, and github seems to have no examples of 
anyone using it. All the variations I tried based on the official doc failed, 
by failing to pass any sources to the javadoc command.

I tried to fall back to making it merely work to say {{mvn javadoc:aggregate}} 
from command line and spare typing all those options. That didn't help, 
however, because excludepackagenames does not work. The reason is a rather old 
and deep bug in the plugin -- it always calls javadoc with a long list of 
individual java source files. The javadoc option for excluding packages does 
not work in this case.

So, as you will see, there is a bunch of configuration in the top pom to 
improve the javadoc jar files that are attached for each component, and then 
some of the same information is in the new directory, javadoc-aggregate, which 
uses ant to do the actual javadocing.

Normally, I'd offer the idea of fixing the javadoc plugin and then using the 
results, but my personal history in trying to repair that thing was not very 
successful.


> High-quality javadoc for Beam
> -----------------------------
>
>                 Key: BEAM-475
>                 URL: https://issues.apache.org/jira/browse/BEAM-475
>             Project: Beam
>          Issue Type: Improvement
>          Components: project-management
>            Reporter: Daniel Halperin
>            Assignee: Benson Margulies
>             Fix For: Not applicable
>
>
> We should have good Javadoc for Beam!
> Current snapshot: http://beam.incubator.apache.org/javadoc/0.1.0-incubating/



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to