You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-user@axis.apache.org by Rodrigo Ruiz <rr...@gridsystems.com> on 2003/07/23 12:28:20 UTC

Can method parameters be documented in WSDL?

Hi all,

I am trying WSDL2Java to generate my client classes with javadoc comments.
I can include a simple documentation tag in my WSDL descriptor, like:

<wsdl:operation name="getGroup" parameterOrder="name">
  <wsdl:documentation>
    Retrieves data about a group
  </wsdl:documentation>
  ...
</wsdl:operation>

And this leads to the following code:

/**
 * Retrieves data about a group
 */
public Group getGroup(String name) ...

But I have tried to document the "name" parameter with no success. "NewLine"
characters are removed from the documentation text, so the whole comment
comes in a single line (and this way javadoc does not correctly parse the
@param tags).
I have also tried to add a documentation tag inside the part tags in the
message definition, but this seems to have no effect.

Has somebody done this? If this feature is not present in WSDL2Java, I
suppose I will post it via bugzilla, but I wanted to check it here before
:-)

PS: I am using Axis 1.0

--
GRIDSYSTEMS                    Rodrigo Ruiz Aguayo
Parc Bit - Son Espanyol        Analista Programador
07120 Palma de Mallorca        rruiz@gridsystems.com
Baleares - España              Tel:+34-971435085
www.gridsystems.com            Fax:+34-971435082


Re: Can method parameters be documented in WSDL?

Posted by Davanum Srinivas <di...@yahoo.com>.
Please post it as a bug to bugzilla. Please post your wsdl as well.

-- dims

--- Rodrigo Ruiz <rr...@gridsystems.com> wrote:
> Hi all,
> 
> I am trying WSDL2Java to generate my client classes with javadoc comments.
> I can include a simple documentation tag in my WSDL descriptor, like:
> 
> <wsdl:operation name="getGroup" parameterOrder="name">
>   <wsdl:documentation>
>     Retrieves data about a group
>   </wsdl:documentation>
>   ...
> </wsdl:operation>
> 
> And this leads to the following code:
> 
> /**
>  * Retrieves data about a group
>  */
> public Group getGroup(String name) ...
> 
> But I have tried to document the "name" parameter with no success. "NewLine"
> characters are removed from the documentation text, so the whole comment
> comes in a single line (and this way javadoc does not correctly parse the
> @param tags).
> I have also tried to add a documentation tag inside the part tags in the
> message definition, but this seems to have no effect.
> 
> Has somebody done this? If this feature is not present in WSDL2Java, I
> suppose I will post it via bugzilla, but I wanted to check it here before
> :-)
> 
> PS: I am using Axis 1.0
> 
> --
> GRIDSYSTEMS                    Rodrigo Ruiz Aguayo
> Parc Bit - Son Espanyol        Analista Programador
> 07120 Palma de Mallorca        rruiz@gridsystems.com
> Baleares - Espa�a              Tel:+34-971435085
> www.gridsystems.com            Fax:+34-971435082
> 


=====
Davanum Srinivas - http://webservices.apache.org/~dims/

__________________________________
Do you Yahoo!?
Yahoo! SiteBuilder - Free, easy-to-use web site design software
http://sitebuilder.yahoo.com