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 Fri, 27 Dec 2013 18:25:52 GMT

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

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

Hi Francesco,

I've done with the initial try at scraping the docs from the JavaDoc-generated HTML.
It has proved to be somewhat messy given that the generated HTML is different between Java6
and Java 7 (and I guess Java 8), but I'm hoping, after tuning it a bit more and making it
more customizable, that it will work predictably.

So the idea is that a WADLGenerator property "javaDocPath" is set to something like "classpath:/javadocs/myappdocs.jar"
and it works, or, alternatively, a property "documentationProvider" is set to an instance
of JavaDocProvider, the latter option will be useful when a customized  JavaDocProvider is
available.

I'm thinking that a build-time generation of the WADL can be much more involved for it to
match the flexibility offered by a run-time generation, however, I believe this option is
still open, but at some later stage.

Please give it a try when you get a chance
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
>
> 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