There are a couple of config options to control what javadoc is generated for.

Exclude packages names[1] allows the contents of packages to be excluded from 
javadoc.
Subpackages[2] allows the listing of packages to be included.

I am not aware of any config that allows individual classes to be selected. 
However, between the selection of packages and visibility[3], one should be 
able meet most needs for generating the "right" amount of javadoc.

[1] - 
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames
 
[2] - 
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#subpackages
[3] - 
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#show


Brett Okken | MMF Archive | Software Architect | 816.201.6112 | www.cerner.com 
| [EMAIL PROTECTED]

-----Original Message-----
From: news [mailto:[EMAIL PROTECTED] On Behalf Of Chris
Sent: Monday, October 20, 2008 1:53 PM
To: [email protected]
Subject: Re: Select classes to Javadoc


 >> How do I get the javadoc plugin to do only certain classes?
 >>
 >> The Ant javadoc task does it by letting you pass in a <fileset>. I can't  
 >> >> find the equivalent in Maven.

Martin Gainty wrote:
> take a look at
> maven-javadoc-plugin
> http://maven.apache.org/plugins/maven-javadoc-plugin/
> 
> Here is an example
> <plugin>
>    <groupId>org.apache.maven.plugins</groupId>
>      <artifactId>maven-javadoc-plugin</artifactId>
>          <configuration>
>                 <links>
>                         
> <link>http://java.sun.com/j2ee/1.4.2/docs/api</link>
> 
> and this mechanism for configuring offline links
> 
> if  http://java.sun.com/j2se/1.4.2/docs/api unreachable try 
> /opt/java-apidoc/j2sdk1.4.1/docs/api/
> maven.javadoc.offlineLinks= \
>   
> http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apidoc/j2sdk1.4.1/d
> ocs/api/

Martin, I'm not sure how this helps. What I want to do is include certain 
classes in the javadoc and not others. I think the <links> tag just helps makes 
links between one set of javadoc and another.


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

----------------------------------------------------------------------
CONFIDENTIALITY NOTICE This message and any included attachments are from 
Cerner Corporation and are intended only for the addressee. The information 
contained in this message is confidential and may constitute inside or 
non-public information under international, federal, or state securities laws. 
Unauthorized forwarding, printing, copying, distribution, or use of such 
information is strictly prohibited and may be unlawful. If you are not the 
addressee, please promptly delete this message and notify the sender of the 
delivery error by e-mail or you may call Cerner's corporate offices in Kansas 
City, Missouri, U.S.A at (+1) (816)221-1024.

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to