[jira] [Comment Edited] (CXF-5479) Create a Maven plugin for generating WADL at build time

["Sergey Beryozkin (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CXF-5479?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13956371#comment-13956371 ] 

Sergey Beryozkin edited comment on CXF-5479 at 4/1/14 10:45 AM:
----------------------------------------------------------------

Hi Freeman, thanks for the patch. I think it is looking good and neat.

What I'd like to address though is how JavaDocs can be properly translated to WADL doc. 

org.apache.cxf.jaxrs.model.wadl.JavaDocProvider works but its implementation is far from being perfect as it does the text based primitive analysis of the generated HTML.
So we'd need to run the java docs target before this plugin for a start and we'd also need to configure it to point to the generated JavaDocs archive. 

Can you please experiment a bit more and see how a proper JavaDocs generator operating with the JavaDocs model API can be plugged in ? I think/hope it would also be possible to wrap as DocumentationProvider but I'd like to get it done first before we do commit this code in order to validate that we can have JavaDocs generated. I think we may have already the JavaDocs integration in some of WS tools

Cheers, Sergey


was (Author: sergey_beryozkin):
Hi Freeman, thanks for the patch. I think it is looking good and neat.

What I'd like to address though is how JavaDocs can be properly translated to WADL doc. 

org.apache.cxf.jaxrs.model.wadl.JavaDocProvider works but its implementation is far from being perfect as it does the text based primitive analysis of the generated HTML.
So we'd need to run the java docs target before this plugin for a start and we'd also need to configure it to point to the generated JavaDocs archive. 

Can you please experiment a bit more and see how a proper JacaDocs generator operating with the JavaDocs model API can be plugged in ? I think/hope it would also be possible to wrap as DocumentationProvider but I'd like to get it done first before we do commit this code in order to validate that we can have JavaDocs generated. I think we may have already the JavaDocs integration in some of WS tools

Cheers, Sergey

> Create a Maven plugin for generating WADL at build time
> -------------------------------------------------------
>
>                 Key: CXF-5479
>                 URL: https://issues.apache.org/jira/browse/CXF-5479
>             Project: CXF
>          Issue Type: New Feature
>          Components: JAX-RS
>            Reporter: Sergey Beryozkin
>            Assignee: Freeman Fang
>         Attachments: CXF-5479.patch
>
>




--
This message was sent by Atlassian JIRA
(v6.2#6252)