On Jun 12, 2008, at 3:25 PM, Martin Grotzke wrote:
>
> I'm just starting with a maven-plugin, that generates an xml-file
> containing javadoc information for resource classes (i call it
> resource-doc :)) and another maven-plugin, that reads this
> resourcedoc.xml and passes the unmarshalled ResourceDoc instance to
> the
> WadlGenerator. The WadlGenerator can then use this information to
> add it
> to the generated wadl elements.
>
> Now one could generate the application.wadl at build time,
> package/distribute it with the application and send it to clients when
> the application.wadl is requested.
>
We used to do static WADL generation but we switched to all dynamic
generation so we could support OPTIONS on a single resource as well as
a "global" WADL with the same code.
> For retrieving an application.wadl for some resource (via OPTIONS) IMO
> it would also be nice to get a wadl containing the documentation of
> the
> resource. This would imply, that we would have to read the
> resourcedoc.xml at runtime.
>
Yes, I think that would be desirable.
> A way to keep this flexible would be to create a specialized
> DocumentedWadlGenerator, that extends WadlGenerator, so that clients
> can
> use what is preferred. Of course WadlGenerator methods have to be
> changed to instance methods then. I would prefer this solution.
>
+1, sounds like a plan.
Marc.
>
> On Tue, 2008-06-10 at 10:06 +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?
>>
>> 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?
>>
>> Cheers,
>> Martin
>>
>>
>>
> --
> Martin Grotzke
> Dipl.-Inf.
>
> freiheit.com technologies gmbh
> Straßenbahnring 22 / 20251 Hamburg, Germany
> fon +49 (0)40 / 890584-0
> fax +49 (0)40 / 890584-20
> HRB Hamburg 70814
>
> eb0e 645c 9730 c8a3 ee2f 1b9a 5de5 21cb c259 fe34
> Geschäftsführer: Claudia Dietze, Stefan Richter, Jörg Kirchhof
---
Marc Hadley <marc.hadley at sun.com>
CTO Office, Sun Microsystems.