Hi

On Thu, Mar 24, 2011 at 1:32 PM, Matthew Glubb <[email protected]> wrote:

> On 24 Mar 2011, at 13:17, Sergey Beryozkin wrote:
>
> > I was just thinking about it :-)... I'm wondering, would it make sense to
> > update the class for the annotation be applicable to parameters as well ?
> > Probably yes, what do you think ?
>
> There is also the issue whereby at the moment one cannot document response
> objects. For example:
>
> <method name="GET">
> <doc>Retrieve object data</doc>
> <response status="200">
> <doc>Get data about an existing object</doc>
> <representation />
> </response>
> <response status="404">
> <doc>Request for object that does not exist </doc>
> <representation />
> </response>
> </method>
>
> But this goes to a wider issue that any wadl element can have a doc element
> attached and obviously we are limited with what and where we can annotate.
>
>
I've done few modifications for users be able to document response
representations, input parameters, WADL request & response elements
(wadl:method/wadl:request), using multiple languages if needed. A method
level Description annotation can be used to 'target' the response
representation, the method itself (default), etc. A Descriptions annotation
can group multiple Description annotations, with each one targeting a
specific WADL fragment...
I have to keep this update on the trunk only as there've been movements in
the code base...

Once we start supporting the server-side WADl dev, the docs will be
inherited from the input document...

Thanks, Sergey

Matt
>
>
>

Reply via email to