Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What is the WSDL syntax to populate the "Description" column in the html table? #13

Open
molund opened this issue May 5, 2017 · 3 comments

Comments

@molund
Copy link

molund commented May 5, 2017

I'm trying to use the xs:annotation / xs:documentation tags, but nothing is getting populated in the description column of the HTML tables.

 <s:element minOccurs="1" maxOccurs="1" name="ContactMethodId" type="s:int" >
      <xs:annotation>
          <xs:documentation>Na = 0, RegularMail = 1, Email = 2, VoiceMail = 3, FaxBack = 4, Print = 5</xs:documentation>
      </xs:annotation>
</s:element>

Maybe this feature hasn't been implemented yet? The Stub.java model looks like it will only ever return the words "In header"

	public String getDescription() {
		if (this.header) {
			return "In header";
		}
		return null;
	}
@chenjianjx
Copy link
Owner

chenjianjx commented May 7, 2017

You are right. It's not implemented. Sorry, don't get bandwidth to do it. Have to parse generated java files and extract javadocs. See (https://javaee.github.io/metro/doc/user-guide/ch03.html#generating-javadocs-from-wsdl-documentation)

Pull requests are welcome.

@sco0ter
Copy link

sco0ter commented Aug 31, 2020

I'd be happy to see this feature as well. It's even trickier for my application: We have Java classes, org.apache.cxf:cxf-java2ws-plugin generates WSDL and your plugin generates the documentation from it.

From first glance it's hardly possible to even generate <xs:documentation> tags from JavaDoc (with cxf).

@chenjianjx
Copy link
Owner

chenjianjx commented Aug 31, 2020

Just did a research. This is hard to implement (have to extract javadoc from generated java files). And even if you do, its help is limited:

(Also see javaee/jaxb-v2#172)

Their last one may be the most the important one. If it can't be done, then the whole efforts are not worth it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants