beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Benson Margulies (JIRA)" <>
Subject [jira] [Commented] (BEAM-475) High-quality javadoc for Beam
Date Mon, 16 Jan 2017 19:17:26 GMT


Benson Margulies commented on BEAM-475:

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

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:
>             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:

This message was sent by Atlassian JIRA

View raw message