[ http://jira.codehaus.org/browse/XFIRE-507?page=comments#action_80520 ]
Tomasz Sztelak commented on XFIRE-507:
--------------------------------------
Ok, Just commited some initial work for wsdl:documentation support ( java->wsdl
for now ).
Cofiguration of this feature is similar to aegis mapping files, you must place
file MyService.doc.xml in folder where MyService.class is located. Config file
has following syntax :
<service>
<documentation>
DOCUMENTATION FOR SERVICE
</documentation>
<method name="METHOD_NAME" parametersNumber="NUMBER_OF_METHOD_ARGUMENTS" >
<documentation>
METHOD DOCUMENTATION
</documentation>
<parameter index="0">
<documentation>
DOCUMENTATION FOR FIRST PARAM
</documentation>
</parameter>
</method>
</service>
Practical sample can be seen in distribution book example.
> Documentation support for WSDL->Java and Java->WSDL
> ---------------------------------------------------
>
> Key: XFIRE-507
> URL: http://jira.codehaus.org/browse/XFIRE-507
> Project: XFire
> Issue Type: Improvement
> Components: Generator
> Affects Versions: 1.1.2
> Reporter: Stefan Freyr Stefansson
> Assigned To: Tomasz Sztelak
> Priority: Minor
> Attachments: documented.wsdl, documented.wsdl
>
>
> It would be good if the XFire "generator" could provide a way to maintain any
> documentation that is done in either WSDL or Java classes.
> This documentation would probably have to be maintained using annotations.
> The reason for this being that retrieveing the JavaDoc from a class file is
> (to my knowledge) not possible and therefore, the JavaDoc cannot be
> transported over to the generated WSDL. However it would of course be
> possible to generate java classes with javadoc from porperly constructed WSDL
> but that would just work in that direction.
> There seem to be different ways to document things in a WSDL file.
> http://www.w3.org/TR/wsdl#_document-s provides a good overview of where an
> <wsdl:documentation> element can be placed but it seems that within the type
> definitions (in the namespace for XSD) there seems to be a tendency to use
> <xsd:annotation><xsd:documentation>...</xsd:documentation></xsd:annotation>.
> Whether there are other ways of doing this I don't know.
> I'm supplying a WSDL file with examples of both the wsdl: and xsd:
> documentations. Please note that I have not tested this WSDL file but I'm
> fairly confident that it should be legal. Also please note that this WSDL
> does not provide an exhaustive test case... that is some items that can be
> documented in the WSDL are not in the file provided (such as the wsdl:message
> element, the wsdl:binding or any sub-element of that or the wsdl:service or
> any sub-element of that).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe from this list please visit:
http://xircles.codehaus.org/manage_email
