ant-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Larry V. Streepy, Jr." <stre...@healthlanguage.com>
Subject Re: javadoc help
Date Wed, 20 Jun 2001 21:50:14 GMT
I understand the difference in specifying just a package vs. a wildcard.
I specifically need to call out the packages I do (for the customer
documentation) since there are other packages in the hierarchy that are
not relevant for customers.

Thanks.

babramo@uswest.com wrote:
> 
> you do not need to specify the wild card if you do not have any subpackges,
> ie
> you have com.company.package1 only and do not have
> com.company.package1.subpackge1
> like in your case, i would think the following will work as well
> <javadoc destdir="${build.customer.doc}"
>              sourcepath="${src.dir}"
>              private="yes"
>              classpath="${base.path}"
>              header="${name}"
>              maxmemory="96m"
>              bottom="${copyright}"
>              packagenames="com.cyberplus.le.ejb.*,
>                            com.cyberplus.util,
>                            com.cyberplus.le.*"/>
> 
> -----Original Message-----
> From: Larry V. Streepy, Jr. [mailto:streepy@healthlanguage.com]
> Sent: Wednesday, June 20, 2001 1:53 PM
> To: ant-user@jakarta.apache.org
> Subject: Re: javadoc help
> 
> In my build, I didn't need to specify a wild card.  Here are two forms
> that I use in our build:
> 
>     <javadoc destdir="${build.customer.doc}"
>              sourcepath="${src.dir}"
>              private="yes"
>              classpath="${base.path}"
>              header="${name}"
>              maxmemory="96m"
>              bottom="${copyright}"
>              packagenames="com.cyberplus.le.ejb,
>                            com.cyberplus.le.ejb.error,
>                            com.cyberplus.util,
>                            com.cyberplus.le.client.tools,
>                            com.cyberplus.le.server.web.servlet"/>
> 
> and
> 
>     <javadoc destdir="${build.internal.doc}"
>              sourcepath="${src.dir}"
>              private="yes"
>              classpath="${base.path}"
>              header="${name}"
>              maxmemory="96m"
>              bottom="${copyright}"
>              packagenames="**/.*"/>
> 
> Diane Holt wrote:
> >
> > Is "stp" the actual name of your package?  The example in the doc shows:
> >  <javadoc packagenames="com.dummy.test.*"
> >     ...
> > So I would guess you need to specify the actual package name and terminate
> > it with a wildcard -- eg: com.foo.stp.*
> >
> > Diane
> >
> > --- Suu Quan <squan@wwc.com> wrote:
> > > I'm trying to understand how to make <javadoc> work.
> > >
> > > 1. I tried packagenames="..." (pretty much copied from the manual)
> > >
> > > <javadoc destdir="docs"
> > >         packagenames="stp" sourcepath="/stp"
> > >         classpathref="classpath" (<-- this one is good, used for other
> > > tasks)
> > >         verbose="true"
> > >         author="true"
> > >         version="true"
> > > >
> > > <group title="utils" packages="utils.*;utils/ldap/*;utils/net/*" />
> > > <group title="stputils" packages="stputils.*" />
> > > </javadoc>
> > >
> > > I got as output
> > > doc:
> > >   [javadoc] Generating Javadoc
> > >   [javadoc] Javadoc execution
> > >   [javadoc] javadoc: No package, class, or source file found named stp.
> > >   [javadoc] 1 error
> > >
> > > 2. I've tried
> > > sourcefiles="**/*.java"
> > >
> > > but it is not what is expected: a comma separated list of files. And I
> > > have too many to list.
> > >
> > > My example is a pretty simple one. Suggestion?
> > >
> > > tia
> > >
> > > Suu Quan
> > > squan@wwc.com
> > >
> >
> > =====
> > (holtdl@yahoo.com)
> >
> > __________________________________________________
> > Do You Yahoo!?
> > Get personalized email addresses from Yahoo! Mail
> > http://personal.mail.yahoo.com/
> 
> --
> Larry V. Streepy, Jr.
> Chief Technical Officer and VP of Engineering
> 
> Health Language, Inc.  -- "We speak the language of healthcare"
> 
> 970/626-5028 (office)           mailto:streepy@healthlanguage.com
> 970/626-4425 (fax)              http://www.healthlanguage.com

-- 
Larry V. Streepy, Jr.
Chief Technical Officer and VP of Engineering

Health Language, Inc.  -- "We speak the language of healthcare"

970/626-5028 (office)           mailto:streepy@healthlanguage.com
970/626-4425 (fax)              http://www.healthlanguage.com

Mime
View raw message