[
https://issues.apache.org/jira/browse/CXF-5353?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13858759#comment-13858759
]
Francesco Chicchiriccò commented on CXF-5353:
---------------------------------------------
Hi Sergey,
I've made the following changes to Syncope trunk:
# changed {{common/pom.xml}} to attach Javadocs JAR to build lifecycle:
{code:xml}
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>{code}
# changed the WadlGenerator Spring bean (in
{{core/src/main/resources/restContext.xml}}) to
{code:xml}
<bean id="wadlGenerator"
class="org.apache.cxf.jaxrs.model.wadl.WadlGenerator">
<property name="applicationTitle" value="Apache Syncope
${project.version}"/>
<property name="namespacePrefix" value="syncope"/>
<property name="linkJsonToXmlSchema" value="true"/>
<property name="useJaxbContextForQnames" value="true"/>
<property name="ignoreMessageWriters" value="true"/>
<property name="addResourceAndMethodIds" value="true"/>
<property name="javaDocPath"
value="/WEB-INF/lib/syncope-common-${project.version}-javadoc.jar"/>
</bean>{code}
(I struggled a bit to find the correct way to specify the {{javaDocPath}}
value, but this seems to be working, at least I don't get any exception)
However, I don't see any {{<doc/>}} in the generated WADL besides the ones I
once added to {{UserService}} via 'traditional' {{@Description}}; moreover, now
I see two identycal {{<xs:schema/>}} elements under {{<grammar/>}}.
What am I doing wrong?
> 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)
