2009年11月30日星期一

[fw-webservices] Node documentation

With help of phpdoc it is possible to create a function description in wsdl,
for instance:

/**
* Here goes the description
* @return string
*/
public function myFunction(){
}

will result in:

<operation name="myFunction">
<documentation>Here goes the description</documentation>
<input message="tns:myFunctionIn" />
<output message="tns:myFunctionOut" />
</operation>

Is it also possible to add a description to a complex return type or to the
properties of a complex return type?
What I would like is something like the following:

<xsd:complexType name="Foo">
- <xsd:all>
<documentation>Here goes the description of the Foo Class</documentation>
<xsd:element name="fooElement" type="tns:fooElement">
<documentation>Here goes the description of the Foo
property</documentation>
</xsd:element>
</xsd:all>
</xsd:complexType>
...
<message name="functionNameOut">
<part name="return" type="tns:Foo" />
</message>
....

I tried various options like adding a text at the start of the return class
and adding comments after the property definition, for instance @var string
This is a help text, but nothing seems to generate a documentation tag.

With these extra documentation tags you will be able to generate complete
human readable documentation with help of an xsl style sheet.

--
View this message in context: http://n4.nabble.com/Node-documentation-tp931498p931498.html
Sent from the Zend Web Services mailing list archive at Nabble.com.

没有评论: