You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@myfaces.apache.org by Werner Punz <we...@gmail.com> on 2011/08/12 15:34:53 UTC

jsdocs + build tools

Hi Everyone

Status update: I have a preliminary maven plugin up and running which 
triggers jsdoc upon our javascript assembly.xml information.
I will refine the plugin and once good enough I will merge it as 
preliminary version into our build tools in a few weeks.

I started basically from scratch because I wanted it to use our assembly 
information which we also use for compression.

The question now is more along the lines since I start the refinement phase.

What do we want to do with the plugin. There are several options:

a) provide a separate jsdoc goal which generates the jsdocs

or

b) generate the jsdocs in the same phase as our javadocs and bundle the 
generated jsdocs along the javadocs.

Werner



Re: jsdocs + build tools

Posted by Mark Struberg <st...@yahoo.de>.
+1 for a.) too :)

LieGrue,
strub

--- On Fri, 8/12/11, Jakob Korherr <ja...@gmail.com> wrote:

> From: Jakob Korherr <ja...@gmail.com>
> Subject: Re: jsdocs + build tools
> To: "MyFaces Development" <de...@myfaces.apache.org>
> Date: Friday, August 12, 2011, 1:43 PM
> Hi Werner,
> 
> Great!!
> 
> Frankly, I'd prefer a).
> 
> Regards,
> Jakob
> 
> 2011/8/12 Werner Punz <we...@gmail.com>:
> > Hi Everyone
> >
> > Status update: I have a preliminary maven plugin up
> and running which
> > triggers jsdoc upon our javascript assembly.xml
> information.
> > I will refine the plugin and once good enough I will
> merge it as preliminary
> > version into our build tools in a few weeks.
> >
> > I started basically from scratch because I wanted it
> to use our assembly
> > information which we also use for compression.
> >
> > The question now is more along the lines since I start
> the refinement phase.
> >
> > What do we want to do with the plugin. There are
> several options:
> >
> > a) provide a separate jsdoc goal which generates the
> jsdocs
> >
> > or
> >
> > b) generate the jsdocs in the same phase as our
> javadocs and bundle the
> > generated jsdocs along the javadocs.
> >
> > Werner
> >
> >
> >
> 
> 
> 
> -- 
> Jakob Korherr
> 
> blog: http://www.jakobk.com
> twitter: http://twitter.com/jakobkorherr
> work: http://www.irian.at
> 

Re: jsdocs + build tools

Posted by Jakob Korherr <ja...@gmail.com>.
Hi Werner,

Great!!

Frankly, I'd prefer a).

Regards,
Jakob

2011/8/12 Werner Punz <we...@gmail.com>:
> Hi Everyone
>
> Status update: I have a preliminary maven plugin up and running which
> triggers jsdoc upon our javascript assembly.xml information.
> I will refine the plugin and once good enough I will merge it as preliminary
> version into our build tools in a few weeks.
>
> I started basically from scratch because I wanted it to use our assembly
> information which we also use for compression.
>
> The question now is more along the lines since I start the refinement phase.
>
> What do we want to do with the plugin. There are several options:
>
> a) provide a separate jsdoc goal which generates the jsdocs
>
> or
>
> b) generate the jsdocs in the same phase as our javadocs and bundle the
> generated jsdocs along the javadocs.
>
> Werner
>
>
>



-- 
Jakob Korherr

blog: http://www.jakobk.com
twitter: http://twitter.com/jakobkorherr
work: http://www.irian.at