Bug 923804

Summary: Make Javadoc generation consume just EAP source zip (no workaround using upstream sources)
Product: [JBoss] JBoss Enterprise Application Platform 6 Reporter: Ondřej Žižka <ozizka>
Component: distributionAssignee: jboss-set
Status: CLOSED EOL QA Contact:
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 6.2.0CC: fnasser, pgier
Target Milestone: ---Keywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
URL: https://github.com/jbossas/jboss-as/pull/4199
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1329314 (view as bug list) Environment:
Last Closed: 2019-08-19 12:48:33 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Ondřej Žižka 2013-03-20 13:35:31 UTC
Creating aggregated javadoc for such a big project like AS is a few-step process, during which various issues appear: Maven bugs, wrong data in pom.xml's and jars (mostly 3rd party outside our scope), javadoc generator bugs.

For all of these, we have some kind of workaround, mostly blacklisting the offending jars / artifacts.

This process (including workarounds) was automated in the form of a Jenkins job.

All this was done for AS 7.

 

For EAP 6, the same process was not applicable at the time of developing, as even more problems emerged - not all artifacts had -source.jar's.

I've tried to replace these with fake ones.

That worked, but then, for some reason, the javadoc tool, when run, doesn't provide any output. It runs as with AS 7, downloads the source packages, but after that, it quits with no error, and simply doesn't create the javadoc dir nor .jar.

 

We decided to go with the hybrid approach of generating Javadoc from AS tag which EAP is based on, and apply EAP's module.xml's which determine what modules the public API consists of.

This approach worked until current release, EAP 6.1.0 for which we have an upstream code base.

But for 6.1.next, we need to be able to generate javadoc purely from EAP sources, without relying on AS upstream.

This will need an analysis why the javadoc tool or maven javadoc plugin fails to create any output, and possibly ask an expert (John Casey?) to help with fixing.

Comment 1 Ondřej Žižka 2013-03-22 02:45:25 UTC
Upstream PR: https://github.com/jbossas/jboss-as/pull/4199

Comment 2 Ondřej Žižka 2013-03-22 04:46:28 UTC
Upstream PR: https://github.com/jbossas/jboss-as/pull/4199

Comment 4 Ondřej Žižka 2013-07-18 21:22:03 UTC
Still missing src jars in for EAP artefacts.  Blocked by that.