Mailing-List: contact buildr-user-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: buildr-user@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of vic.borja@gmail.com
 designates 209.85.198.248 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=message-id:date:from:to:subject:in-reply-to:mime-version
         :content-type:references;
        b=U89MpyBXPaWRiTx3mJWQ3s4JWUz9JLDqhVfbuGL+6WXzWk3vZwBMWHSBTSs4Z/GIEf
         dkCs00W1OEv+CYrhtFfNmXxoGoZy7JVjtfHvKfewiyudiUlNsMyUaTwsvPzMYHyD0XF8
         q8UaGxJp1dTX1uGbw4LlYxVnH7sg3zavaK+fY=
Message-ID: <53466cf0809121037y7cde3991g2c18280da5d87bb4@mail.gmail.com>
Date: Fri, 12 Sep 2008 12:37:06 -0500
From: "Victor Hugo Borja" <vic.borja@gmail.com>
To: buildr-user@incubator.apache.org
Subject: Re: javadoc
In-Reply-To: <3de5d7d20809121015l340fffm95d917850e8b8d4b@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/alternative;
	boundary="----=_Part_30381_13287878.1221241026715"
References: <6539b1ea0809112257r35066654p8cf23a365b9bb75@mail.gmail.com>
	 <3de5d7d20809120955q59c43af9if76dbfaf033acb5@mail.gmail.com>
	 <53466cf0809121000l6f29e95dl263deefad6efa1b3@mail.gmail.com>
	 <3de5d7d20809121015l340fffm95d917850e8b8d4b@mail.gmail.com>

------=_Part_30381_13287878.1221241026715
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

I see..., and what you comment makes sense.
So in order to generate javadoc for some projects all in the same target
directory:

   define 'foo'

       define 'bar-api' do
            # just interfaces
       end
       define 'bar-impl' do
            # the impl, private classes, etc
       end
       define 'baz' do
           # another project
       end

       javadoc projects('bar_api', 'baz')
   end

# buildr javadoc

On Fri, Sep 12, 2008 at 12:15 PM, Assaf Arkin <arkin@intalio.com> wrote:

> On Fri, Sep 12, 2008 at 10:00 AM, Victor Hugo Borja <vic.borja@gmail.com>
> wrote:
> > I think some users may expect the javadoc task to be recursive just like
> > compile task, so that executing
> >
> >   > buildr javadoc
> >
> > would generate javadoc for all projects defined.
> >
> > Should it be made recursive? If so, all it takes is adding
> > project.recursive_task('javadoc') at java/compilers.rb:363
>
> We can add that, but result is that it will recursively run all the
> javadoc tasks which will recursively do nothing interesting.
>
> Javadoc tasks by default don't do anything, you need to tell each task
> which source directories it should operate on.  The reason for that:
> if the default behavior was for javadoc to run with the same paths as
> compile.sources, and run recursively, you will get a lot of javadoc
> output directories (one per project).  That's not what people want.
> Most often, it's consolidated output from several different sources
> (typically just the APIs), that way you get the package list, indexes,
> cross reference working across the entire documentation.
>
> To accommodate for that, javadoc expects that you'll tell it exactly
> which sources you want to document (typically projects), and you only
> need one task to do that.
>
> Assaf
>
> >
> >
> > On Fri, Sep 12, 2008 at 11:55 AM, Assaf Arkin <arkin@intalio.com> wrote:
> >
> >> On Thu, Sep 11, 2008 at 10:57 PM, Nicolas Modrzyk <hellonico@gmail.com>
> >> wrote:
> >> > Hi List,
> >> >
> >> > I was trying to generate the javadoc for the whole set of projects,
> >> > where all the projects are children of a single parent project.
> >> > Typing
> >> > buildr javadoc
> >> > at the root of the parent project, did not create anything:
> >> >
> >> > ========================================
> >> > (~/projects/tempo53)>buildr javadoc
> >> > (in /Users/niko/projects/tempo53, development)
> >> > Completed in 1.352s
> >> > ========================================
> >> >
> >> > What would be the proper way to get the javadoc for all the projects
> >> > aggregated in the same place ?
> >>
> >> javadoc projects('foo', 'bar', etc)
> >>
> >> http://incubator.apache.org/buildr/rdoc/classes/Buildr/Javadoc.html
> >>
> >> >
> >> > Niko,
> >> >
> >>
> >
> >
> >
> > --
> > vic
> >
> > Quaerendo invenietis.
> >
>


-- 
vic

Quaerendo invenietis.

------=_Part_30381_13287878.1221241026715--