Red Hat Bugzilla – Bug 724656
BRMS Drools javadocs - multiple subdirectories - no top-level index.html file
Last modified: 2013-03-05 23:19:04 EST
The Drools javadocs in BRMS 5.1 include these directories:
drools-ant drools-compiler drools-grid-task drools-jsr94 drools-repository drools-workitems
drools-api drools-core drools-guvnor drools-persistence-jpa drools-server guvnor-importer
drools-bam drools-decisiontables drools-gwt-console drools-pipeline drools-simulator jcr-api
drools-bpmn2 drools-doc drools-gwt-form drools-planner-core drools-spring jcr-jr-impl
drools-camel drools-factconstraint drools-gwt-graph drools-planner-examples drools-templates jcr-ms-impl
drools-clips drools-grid-core drools-ide-common drools-process-task drools-verifier sample-model
Each directory includes an index.html file - but there is no overall index.html file - the user must navigate the directory tree and open each index.html file individually.
Only drools-api is considered backwards compatible API afaik.
With the maven-javadoc-plugin it should be possible to use <aggregate>true</> to get an aggregation of all javadocs.
With the split-up on 5.2, it might be interesting to implement that there first, and get one per repository (drools, guvnor, integration).
If so, create a GUVNOR issue and assign it to me.
We seem to not be shipping javadocs inside the distribution packages. If that is correct, please close this as NOTABUG.
We ended up shipping the jadavocs. Thus this one needs to be resolved for the next release.
At the .org side this is the situation:
In Drools we're shipping the public API javadocs (knowledge-api).
TIP: An overall index.html file is easy:
- Don't configure javadocs per module
- But in the assembly distribution, configure a dependency-aggretation of all the stuff you want javadocs for:
Notice that this even works over-repositories.
Here's the code how to do it:
724656 Aggregate the drools javadoc producing a single top level index file
Update status to ON_QA. Please verify them against ER6.
Ryan, in order to verify this, I need a location for the Javadoc files. There are none for ER6. Thanks!
(In reply to comment #8)
> Ryan, in order to verify this, I need a location for the Javadoc files.
> There are none for ER6. Thanks!
Yes, sorry, my mistake.
The ER7's javadoc has been add up to : http://jawa05.englab.brq.redhat.com/candidate/BRMS-5.3.0-ER7/brms-p-5.3.0.BRMS-ER7-javadocs.zip
This bug is still valid. There are multiple top-level directories and no index.
Also, there's just drools and modeshape - no jBPM?
This is not (and IMHO shouldn't be) a blocker for 5.3.
Sorry, my bad. This ticket is way too obsolete - the requested funcitonality is there, but the package has morphed into something different in the meantime. I'll open another BZ for the new issue.