Menu

#6 gSOAP directives for documentation of method arguments

open
nobody
None
5
2005-08-26
2005-08-26
No

It would be very useful to have gSOAP directives for
documentation of webservice method arguments and
members of datatypes. This would make it possible to
create an XSLT for generating documentation from a WSDL.

Currently documentation directives are only supported
for service, service methods and datatypes.

My suggestions for an enhancement are:

1) a directive for documenting method arguments.

for example like this:

//gsoap namespace-prefix service param-documentation:
method-name param-name documentation text

It should be possible to add those without inflicting
the SOAP standard because the W3C SOAP specification
states explicitly: "The documentation element is
allowed inside any WSDL language element."
http://www.w3.org/TR/wsdl#_documentation

2) a directive for documenting datatype members.

for example like this:

//gsoap namespace-prefix schema
type-member-documentation: type-name member-name
documentation text

It should be possible to do this too, according to the
W3C XSD specification, section 2.6 Annotations:
http://www.w3.org/TR/xmlschema-0/#CommVers

I hope you think these are two features, which make
sense. Thank you.

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.