cxf-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sergey Beryozkin (JIRA)" <>
Subject [jira] [Commented] (CXF-5479) Create a Maven plugin for generating WADL at build time
Date Mon, 21 Apr 2014 17:44:15 GMT


Sergey Beryozkin commented on CXF-5479:

Hi Freeman

It looks like exactly what we need, thanks for keeping looking into it.
For now I'd only do two minor updates to the patch:
1. Rename DumpedDocFileProvider: It is the implementation detail, the fact we pick up the
info from the dumped file, we may chnage it in the future, we never know :-).

2. Consider moving this provider from "/rt/rs/description/src/main/java/org/apache/cxf/jaxrs/model/wadl/"
to the plugin module, we can not really use this provider without this plugin and as such
I'd rather keep it within the plugin. I guess we can have a case in theory where a user has
prepared this properties file out of band, without even depending on Java docs, and as such
this provider can act as a bridge between all sort of documentation media and the WADL generator.
I'm not sure how realistic it is though: it would probably be simpler to create WADL manually
instead of creating the documentation  map:-)

I'd leave it up to you to make the decision. If you decide to keep it inside rt/rs/description
then please rename to something like ResourceMapJavaDocProvider, if you agree with moving
it into the plugin module then rename to PluginJavaDocProvider or may be also to  ResourceMapJavaDocProvider...

Overall it looks good IMHO

Thanks, Sergey  

> Create a Maven plugin for generating WADL at build time
> -------------------------------------------------------
>                 Key: CXF-5479
>                 URL:
>             Project: CXF
>          Issue Type: New Feature
>          Components: JAX-RS
>            Reporter: Sergey Beryozkin
>            Assignee: Freeman Fang
>         Attachments: CXF-5479-doclet.patch, CXF-5479.patch

This message was sent by Atlassian JIRA

View raw message