Controlling javadoc packages in large multi project reactor build

[kelvin goodson <ke...@apache.org>]

I want to produce selective javadoc in a project where we are in the
process of defining what is SPI.  The packages containing SPI are
currently distributed amongst the projects in a non-ideal way.

I have tried using the excludePackageNames config element, but it
seems to be failing to handle the large number of packages I want to
exclude.  I have over 100 packages to exclude, and wildcards in the
excludePackageNames value will not reduce the the string length of
this value considerably.

I looked for documentation to clarify excludePackageNames, but did not
find what I need, so I experimented [1] and found that
a) if multiple excludePackageNames elements are included in the config
then only the last value takes effect
b) the value of the excludePackageNames element can not be split over
multiple lines

Is this what you would expect?
Are there other ways of configuring this plugin for selective javadoccing?

[1] https://svn.apache.org/repos/asf/tuscany/sandbox/kgoodson/testroot/

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org

RE: Controlling javadoc packages in large multi project reactor build

[Martin Gainty <mg...@hotmail.com>]

try colon
 javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java.net:java.lang

 

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#runningjavadoc

 

hth
Martin
______________________________________________ 
Verzicht und Vertraulichkeitanmerkung/Note de déni et de confidentialité

Diese Nachricht ist vertraulich. Sollten Sie nicht der vorgesehene Empfaenger sein, so bitten wir hoeflich um eine Mitteilung. Jede unbefugte Weiterleitung oder Fertigung einer Kopie ist unzulaessig. Diese Nachricht dient lediglich dem Austausch von Informationen und entfaltet keine rechtliche Bindungswirkung. Aufgrund der leichten Manipulierbarkeit von E-Mails koennen wir keine Haftung fuer den Inhalt uebernehmen.

Ce message est confidentiel et peut être privilégié. Si vous n'êtes pas le destinataire prévu, nous te demandons avec bonté que pour satisfaire informez l'expéditeur. N'importe quelle diffusion non autorisée ou la copie de ceci est interdite. Ce message sert à l'information seulement et n'aura pas n'importe quel effet légalement obligatoire. Étant donné que les email peuvent facilement être sujets à la manipulation, nous ne pouvons accepter aucune responsabilité pour le contenu fourni.



 

> From: wsmoak@gmail.com
> Date: Sat, 29 May 2010 19:18:09 -0400
> Subject: Re: Controlling javadoc packages in large multi project reactor build
> To: users@maven.apache.org
> 
> On Sat, May 29, 2010 at 7:01 PM, kelvin goodson
> <ke...@apache.org> wrote:
> 
> > I looked for documentation to clarify excludePackageNames, but did not
> > find what I need,
> 
> Does this help?
> http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames
> 
> > so I experimented [1] and found that
> > a) if multiple excludePackageNames elements are included in the config
> > then only the last value takes effect
> 
> Expected, or perhaps it should throw an error. It's a single element.
> Somewhat unintuitive, since in other places when there's a plural
> tag, you are meant to put multiple singular ones inside:
> <excludePackageNames><excludePackageName>...</excludePackageName> and
> so on.
> 
> > b) the value of the excludePackageNames element can not be split over
> > multiple lines
> 
> Doc says separate with commas, colons or semicolons, so I'd just keep
> typing... (no hard return, iow.)
> 
> No idea if there's a limit though, I haven't tried it.
> 
> -- 
> Wendy
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
 		 	   		  
_________________________________________________________________
The New Busy is not the old busy. Search, chat and e-mail from your inbox.
http://www.windowslive.com/campaign/thenewbusy?ocid=PID28326::T:WLMTAGL:ON:WL:en-US:WM_HMP:042010_3

Re: Controlling javadoc packages in large multi project reactor build

[Wendy Smoak <ws...@gmail.com>]

On Sat, May 29, 2010 at 7:01 PM, kelvin goodson
<ke...@apache.org> wrote:

> I looked for documentation to clarify excludePackageNames, but did not
> find what I need,

Does this help?
http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames

> so I experimented [1] and found that
> a) if multiple excludePackageNames elements are included in the config
> then only the last value takes effect

Expected, or perhaps it should throw an error.  It's a single element.
 Somewhat unintuitive, since in other places when there's a plural
tag, you are meant to put multiple singular ones inside:
<excludePackageNames><excludePackageName>...</excludePackageName> and
so on.

> b) the value of the excludePackageNames element can not be split over
> multiple lines

Doc says separate with commas, colons or semicolons, so I'd just keep
typing... (no hard return, iow.)

No idea if there's a limit though, I haven't tried it.

-- 
Wendy

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org