Uploaded image for project: 'CXF'
  1. CXF
  2. CXF-5375

xjc-javadoc plugin for generating more javadocs from xsd:documentation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0.0-milestone1
    • Component/s: Tooling
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      Description

      Answering Stackoverflow question:
      http://stackoverflow.com/questions/19444064/cxf-wsdl2java-not-generating-javadoc-for-members
      I noticed that there is a lack of support for xsd:documentation in XJC. Generated code representing some elements (like properties or attributes) does not have proper javadocs based on xsd:documentation. There is JAXB bug raised:
      https://java.net/jira/browse/JAXB-172
      but it is not resolved for over 7 years. There is also link to CXF bug CXF-2486 and there is Dan Kulp's comment:

      If you'd like to donate the code to CXF, we could certainly use it. CXF
      already has a couple plugins to workaround XJC issues.

      However I didn't see such a plugin in CXF project, I didn't found it on the internet. So I decided to try to develop one. The result is available at my github account:
      https://github.com/destin/xjc-javadoc-plugin
      The plugin solves CXF-2486 problem (output java file is available as attachment) and makes generated files better documented. I am willing to contribute this plugin to CXF XJC utils (http://cxf.apache.org/xjc-utils.html).

      I tested it on several larger XSD files, also there are few almost end-to-end automated tests.

      Please let me know whether you are interested in taking over this plugin and what modifications do you expect.

        Attachments

        1. HTTPClientPolicy.java
          31 kB
          David Pytel

          Activity

            People

            • Assignee:
              dkulp Daniel Kulp
              Reporter:
              dpytel David Pytel
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: