users@jersey.java.net

Re: [Jersey] generate wadl including source comments

From: Paul Sandoz <Paul.Sandoz_at_Sun.COM>
Date: Tue, 10 Jun 2008 10:49:03 +0200

Martin Grotzke wrote:
> Hi,
>
> I want to improve the generation of wadl so that resource and method
> comments are added to the related wadl-elements.
>
> The idea is basically that of Seth Call: Create some xml-representation
> of the javadoc so that this information can be read when the wadl is
> generated.
>
> Additionally we want to be able to add examples for representations, so
> that it's easy for readers of the doc to get an idea of in/out data.
> My idea is to create a taglet like "@request.representation.example".
> Are there any suggestions / other requirements concerning this that I
> should/could take into consideration?
>
> Also we want to reference schema elements in our representations.
>
> I would prefer do improve the existing jersey WadlGenerator that writing
> our own.
> @jersey-devs: Is this also s.th. that you would prefer?
>

The above proposal looks like good start.


> I would start with a maven-plugin so that testing cycles are as short as
> possible. Then I would create the taglets/doclets, create the required
> javadoc-xml file and afterwards extend the WadlGenerator.
>
> Shall changes be done in the trunk, or would you prefer to keep this in
> a branch?
>

A branch please, then it won't conflict with a 0.8 release.

Paul.

-- 
| ? + ? = To question
----------------\
    Paul Sandoz
         x38109
+33-4-76188109