You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by "Bernstein, Brian J." <br...@credit-suisse.com> on 2010/05/13 21:47:25 UTC

Can't get multi-project javadocs generated based on documentation

Hi,
We have a project that generates several smaller projects that are
individually versioned, released, etc. as they're common components.

We have one project that is a client library for a larger system and it
depends on a few of these smaller projects. I'm having a hard time
trying to figure out how to get a complete javadoc generated where it
doesn't have dead references to other projects.

For example, let's say the project is "clientAPI". This project depends
on "dataObjectsLib" (a shared component with other projects, e.g. a
server component).

I can generate clientAPI's javadocs, but I see dead links like:

	com.foo.dataobjectslib.DataTable getDataTable()

.. In that the return object is not a hyperlink to the DataTable object.

>From what I understood from reading the documentation, if I had
dataObjectsLib's pom configured so that it generates source bundles and
javadoc-resources.jar, the clientAPI should be able to pick up on these
files and use those sources to generate a javadoc that not only has
clientAPI's docs, but also dataObjectsLib's docs and no "dead links"
like the DataTable result above.

The dataObjectsLib target contains:
	dataObjectsLib-1.2.3-SNAPSHOT-javadoc-resources.jar
	dataObjectsLib-1.2.3-SNAPSHOT-javadoc.jar
	dataObjectsLib-1.2.3-SNAPSHOT-sources.jar
	dataObjectsLib-1.2.3-SNAPSHOT.jar

(though javadoc-resources only contains two files; not sure what that is
all about).

The clientAPI seems to pick up the javadoc-resources, but doesn't appear
to generate the @options and @packages for javadoc.bat to also include
the com.foo.dataobjectslib.* package to ultimately not create dead
links.

I am not excluding any package dependencies at the moment and I do have
includeDependencySources set to true. I've tried numerous "aggregate"
forms but nothing seems to work.

Unfortunately, the documentation isn't 100% clear if my expected
behavior is how its supposed to work and further the documentation and
examples don't really point out much about my kind of situation. I
really don't want to resort to specifying long lists of source
directories relatlively pointing to other project's source directories
since that breaks the whole idea of maven's dependency controls!

Any ideas?

-bjb

=============================================================================== 
Please access the attached hyperlink for an important electronic communications disclaimer: 
http://www.credit-suisse.com/legal/en/disclaimer_email_ib.html 
===============================================================================