cxf-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sergey Beryozkin (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CXF-5353) WADLGenerator needs to support existing JavaDocs when possible
Date Mon, 13 Jan 2014 17:42:53 GMT

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

Sergey Beryozkin commented on CXF-5353:
---------------------------------------

Hi Francesco, 
I've fixed it, looks OK to me (and if built with Java7 too, though the list() method with
no parameters is listed last among the 4 list methods in that case).
Can you please double check and if it looks OK then we will resolve this issue ?

Re the mixed approach: do you refer to the combination of Description annotations and JavaDoc
? This works if there's no intersection; JavaDocs covers  DocTarget.RESOURCE, DocTarget.METHOD,
RETURN and PARAM, and you can enrich the docs a bit by adding Description targeting REQUEST
and RESPONSE.

Mixing the text from Description and JavaDoc targeting the same target may work but can also
have side-effects and will complicate WADLGenerator, Description can also direct the text
into either wadl:doc attributes or body and we can some unexpected mix-up. I guess we probably
should not really go there :-), I'd rather work on CXF-5479 a bit later on

Thanks, Sergey

 


> WADLGenerator needs to support existing JavaDocs when possible
> --------------------------------------------------------------
>
>                 Key: CXF-5353
>                 URL: https://issues.apache.org/jira/browse/CXF-5353
>             Project: CXF
>          Issue Type: Improvement
>            Reporter: Sergey Beryozkin
>         Attachments: Syncope-trunk-CXF-5353.patch
>
>
> CXF @Description annotations targeting a given resource method (method itself and its
in and response parameters) will often duplicate what the existing JavaDocs have already documented.

> WADLGenerator needs to do the best effort in trying to incorporate JavaDocs into the
generated document.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)

Mime
View raw message