You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Christian Schulte <cs...@schulte.it> on 2005/10/25 19:16:51 UTC
[m2] How to add Javadoc Report(s) ?
Hi,
I have setup a simple multi module project by looking at the maven
sources on how it is done in maven itself. Everything is working so far
and I am quite happy with maven 2. I cannot figure out how to add a
javadoc "report" to the generated site the right way. I would like to
have either one javadoc generated in the root project's site aggregating
all sources from any module or the javadocs of the different modules
linked to each other so that they become browseable as one document. Is
that possible ? Any help highly appreciated.
--
Christian
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: [m2] How to add Javadoc Report(s) ?
Posted by Christian Schulte <cs...@schulte.it>.
Jason van Zyl schrieb:
>On Tue, 2005-10-25 at 19:16 +0200, Christian Schulte wrote:
>
>>Hi,
>>
>>I have setup a simple multi module project by looking at the maven
>>sources on how it is done in maven itself. Everything is working so far
>>and I am quite happy with maven 2. I cannot figure out how to add a
>>javadoc "report" to the generated site the right way. I would like to
>>have either one javadoc generated in the root project's site aggregating
>>all sources from any module or the javadocs of the different modules
>>linked to each other so that they become browseable as one document. Is
>>that possible ? Any help highly appreciated.
>>
>
>You can generally find info on plugins here:
>
>http://maven.apache.org/plugins/
>
>What you are looking for is here:
>
>http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html
>
>
Thanks for the hint. Just one liddle thing. This documentation is
outdated. It states
offlineLinks:
This option is a variation of -link; they both create links to
javadoc-generated documentation for external referenced classes. See
linkoffline
<http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linkoffline>.
It is a comma separated String.
Its not a comma separated string. For a multi-module project with the
following structure:
Root
Module1
Module2
Module3
In the pom.xml of Root its done like:
<offlineLinks>
<offlineLink>
<url>http://<some base URL>/Module1/apidocs</url>
<location>../Module1/target/site/apidocs</location>
</offlineLink>
<offlineLink>
<url>http://<some base URL>/Module2/apidocs</url>
<location>../Module2/target/site/apidocs</location>
</offlineLink>
<offlineLink>
<url>http://<some base URL>/Module3/apidocs</url>
<location>../Module3/target/site/apidocs</location>
</offlineLink>
</offlineLinks>
--
Christian
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: [m2] How to add Javadoc Report(s) ?
Posted by Jason van Zyl <ja...@maven.org>.
On Tue, 2005-10-25 at 19:16 +0200, Christian Schulte wrote:
> Hi,
>
> I have setup a simple multi module project by looking at the maven
> sources on how it is done in maven itself. Everything is working so far
> and I am quite happy with maven 2. I cannot figure out how to add a
> javadoc "report" to the generated site the right way. I would like to
> have either one javadoc generated in the root project's site aggregating
> all sources from any module or the javadocs of the different modules
> linked to each other so that they become browseable as one document. Is
> that possible ? Any help highly appreciated.
You can generally find info on plugins here:
http://maven.apache.org/plugins/
What you are looking for is here:
http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html
--
jvz.
Jason van Zyl
jason at maven.org
http://maven.apache.org
We all have problems. How we deal with them is a measure of our worth.
-- Unknown
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org