You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by "S?bastien Tardif (JIRA)" <ax...@ws.apache.org> on 2004/11/12 23:28:23 UTC
[jira] Created: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Axis do not generate JavaDoc for the service and port interface.
----------------------------------------------------------------
Key: AXIS-1665
URL: http://nagoya.apache.org/jira/browse/AXIS-1665
Project: Axis
Type: Bug
Components: Serialization/Deserialization
Versions: 1.0-rc1
Environment: CVS Nov 12 2004
Reporter: Sébastien Tardif
Title: Axis do not generate JavaDoc for the service and port interface.
Service and Port are the entries points and so are quite important and should have JavaDoc!
I have a WSDL like this:
...
<wsdl:service name="DocHarborServices">
<xsd:annotation>
<xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
</xsd:annotation>
<wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
<xsd:annotation>
<xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
</xsd:annotation>
<wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
</wsdl:port>
</wsdl:service> -->
</wsdl:definitions>
So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
docHarbor.java extract:
// SHOULD HAVE JAVADOC HERE
public interface DocHarbor extends javax.xml.rpc.Service {
public java.lang.String getdocHarborAddress();
...
and
DocHarborServices.java extract:
// SHOULD HAVE JAVADOC HERE
public interface DocHarborServices extends javax.xml.rpc.Service {
public java.lang.String getdocHarborAddress();
I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Closed: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Posted by "Tom Jordahl (JIRA)" <ax...@ws.apache.org>.
[ http://nagoya.apache.org/jira/browse/AXIS-1665?page=history ]
Tom Jordahl closed AXIS-1665:
-----------------------------
Resolution: Invalid
Closing per comments.
> Axis do not generate JavaDoc for the service and port interface.
> ----------------------------------------------------------------
>
> Key: AXIS-1665
> URL: http://nagoya.apache.org/jira/browse/AXIS-1665
> Project: Axis
> Type: Bug
> Components: Serialization/Deserialization
> Versions: 1.0-rc1
> Environment: CVS Nov 12 2004
> Reporter: Sébastien Tardif
> Attachments: docHarbor.wsdl, docHarbor.wsdl
>
> Title: Axis do not generate JavaDoc for the service and port interface.
> Service and Port are the entries points and so are quite important and should have JavaDoc!
> I have a WSDL like this:
> ...
> <wsdl:service name="DocHarborServices">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
> </wsdl:port>
> </wsdl:service> -->
> </wsdl:definitions>
> So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
> docHarbor.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarbor extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> ...
> and
> DocHarborServices.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarborServices extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
> AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
> AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
> AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
> I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Updated: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Posted by "S?bastien Tardif (JIRA)" <ax...@ws.apache.org>.
[ http://nagoya.apache.org/jira/browse/AXIS-1665?page=history ]
Sébastien Tardif updated AXIS-1665:
-----------------------------------
Attachment: docHarbor.wsdl
Here an example of a WSDL with full documentations in many sections of a WSDL.
> Axis do not generate JavaDoc for the service and port interface.
> ----------------------------------------------------------------
>
> Key: AXIS-1665
> URL: http://nagoya.apache.org/jira/browse/AXIS-1665
> Project: Axis
> Type: Bug
> Components: Serialization/Deserialization
> Versions: 1.0-rc1
> Environment: CVS Nov 12 2004
> Reporter: Sébastien Tardif
> Attachments: docHarbor.wsdl, docHarbor.wsdl
>
> Title: Axis do not generate JavaDoc for the service and port interface.
> Service and Port are the entries points and so are quite important and should have JavaDoc!
> I have a WSDL like this:
> ...
> <wsdl:service name="DocHarborServices">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
> </wsdl:port>
> </wsdl:service> -->
> </wsdl:definitions>
> So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
> docHarbor.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarbor extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> ...
> and
> DocHarborServices.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarborServices extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
> AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
> AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
> AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
> I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Updated: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Posted by "S?bastien Tardif (JIRA)" <ax...@ws.apache.org>.
[ http://nagoya.apache.org/jira/browse/AXIS-1665?page=history ]
Sébastien Tardif updated AXIS-1665:
-----------------------------------
Attachment: docHarbor.wsdl
Attachment is a WSDL having lot of comment (document element) including for the service and port.
> Axis do not generate JavaDoc for the service and port interface.
> ----------------------------------------------------------------
>
> Key: AXIS-1665
> URL: http://nagoya.apache.org/jira/browse/AXIS-1665
> Project: Axis
> Type: Bug
> Components: Serialization/Deserialization
> Versions: 1.0-rc1
> Environment: CVS Nov 12 2004
> Reporter: Sébastien Tardif
> Attachments: docHarbor.wsdl
>
> Title: Axis do not generate JavaDoc for the service and port interface.
> Service and Port are the entries points and so are quite important and should have JavaDoc!
> I have a WSDL like this:
> ...
> <wsdl:service name="DocHarborServices">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
> </wsdl:port>
> </wsdl:service> -->
> </wsdl:definitions>
> So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
> docHarbor.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarbor extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> ...
> and
> DocHarborServices.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarborServices extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
> AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
> AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
> AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
> I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Commented: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Posted by "S?bastien Tardif (JIRA)" <ax...@ws.apache.org>.
[ http://nagoya.apache.org/jira/browse/AXIS-1665?page=comments#action_55736 ]
Sébastien Tardif commented on AXIS-1665:
----------------------------------------
Please close this bug because I get everything working. My confusion came from:
1- Putting document in WSDL specific section use different syntax than putting in the XML Schema section
2- Documentation used for operation when generating *BindingStub.java come from wsdl:binding but to generate service interface and *BindingImpl the documentation come from wsdl:operation. It surely not logic because all of them define or implement the same interface so documentation should come from same place but it's an other issue.
> Axis do not generate JavaDoc for the service and port interface.
> ----------------------------------------------------------------
>
> Key: AXIS-1665
> URL: http://nagoya.apache.org/jira/browse/AXIS-1665
> Project: Axis
> Type: Bug
> Components: Serialization/Deserialization
> Versions: 1.0-rc1
> Environment: CVS Nov 12 2004
> Reporter: Sébastien Tardif
> Attachments: docHarbor.wsdl, docHarbor.wsdl
>
> Title: Axis do not generate JavaDoc for the service and port interface.
> Service and Port are the entries points and so are quite important and should have JavaDoc!
> I have a WSDL like this:
> ...
> <wsdl:service name="DocHarborServices">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
> </wsdl:port>
> </wsdl:service> -->
> </wsdl:definitions>
> So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
> docHarbor.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarbor extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> ...
> and
> DocHarborServices.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarborServices extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
> AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
> AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
> AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
> I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira
[jira] Commented: (AXIS-1665) Axis do not generate JavaDoc for the service and port interface.
Posted by "Davanum Srinivas (JIRA)" <ax...@ws.apache.org>.
[ http://nagoya.apache.org/jira/browse/AXIS-1665?page=comments#action_55507 ]
Davanum Srinivas commented on AXIS-1665:
----------------------------------------
Please submit a patch....instructions are here - http://nagoya.apache.org/wiki/apachewiki.cgi?AxisProjectPages/SubmitPatches
Thanks,
dims
> Axis do not generate JavaDoc for the service and port interface.
> ----------------------------------------------------------------
>
> Key: AXIS-1665
> URL: http://nagoya.apache.org/jira/browse/AXIS-1665
> Project: Axis
> Type: Bug
> Components: Serialization/Deserialization
> Versions: 1.0-rc1
> Environment: CVS Nov 12 2004
> Reporter: Sébastien Tardif
> Attachments: docHarbor.wsdl
>
> Title: Axis do not generate JavaDoc for the service and port interface.
> Service and Port are the entries points and so are quite important and should have JavaDoc!
> I have a WSDL like this:
> ...
> <wsdl:service name="DocHarborServices">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdl:port name="docHarbor" binding="impl:webservicesSoapBinding">
> <xsd:annotation>
> <xsd:documentation xml:lang="en">Contain all operations in docHarbor Web Services. The mode of operation is stateless so you have to provide a Credential instance to every operation.</xsd:documentation>
> </xsd:annotation>
> <wsdlsoap:address location="http://localhost/webservices1_0/services/docHarbor"/>
> </wsdl:port>
> </wsdl:service> -->
> </wsdl:definitions>
> So I was expecting to see in those classes Javadoc having what I specified in xsd:documentation:
> docHarbor.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarbor extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> ...
> and
> DocHarborServices.java extract:
> // SHOULD HAVE JAVADOC HERE
> public interface DocHarborServices extends javax.xml.rpc.Service {
> public java.lang.String getdocHarborAddress();
> I'm surprise because there are many bugs one JavaDoc issues and they are all Closed:
> AXIS-1262 Pulling Javadoc from Unassigned Danno Ferrin Closed Fixed 24/Mar/04 24/Mar/04 Unwatch
> AXIS-766 Generate JavaDoc comments from WSDL comments Axis Developers Mailing List ted stockwell Resolved Duplicate 23/Mar/03 23/Feb/04
> AXIS-604 Generated comments should be javadoc comments Unassigned Steve Loughran Closed Fixed 08/Jan/03 23/Mar/04
> I have attached the WSDL for reference.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://nagoya.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
http://www.atlassian.com/software/jira