Uploaded image for project: 'mdsal'
  1. mdsal
  2. MDSAL-150

Java Binding: missing @return (binding spec. v2)

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Won't Do
    • None
    • None
    • Binding V2 codegen
    • None
    • Operating System: All
      Platform: All

    • 5671

      +++ This bug was initially created as a clone of MDSAL-126 +++

      Java Bindings fail to generate @return, leading to JavaDoc warnings.

      [INFO] — maven-javadoc-plugin:2.10.3:jar (attach-javadocs) @ vbd-api —
      [INFO]
      6 warnings
      [WARNING] Javadoc Warnings
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/Link1.java:23: warning: no @return
      [WARNING] ExternalReference getTunnel();
      [WARNING] ^
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/Topology1.java:23: warning: no @return
      [WARNING] java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TunnelType> getTunnelType();
      [WARNING] ^
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/network/topology/topology/node/BridgeMember.java:43: warning: no @return
      [WARNING] ExternalReference getSupportingBridgeDomain();
      [WARNING] ^
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/network/topology/topology/node/termination/point/_interface/type/TunnelInterface.java:47: warning: no @return
      [WARNING] ExternalReference getTunnelInterface();
      [WARNING] ^
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/network/topology/topology/node/termination/point/_interface/type/UserInterface.java:45: warning: no @return
      [WARNING] ExternalReference getUserInterface();
      [WARNING] ^
      [WARNING] /home/nite/vpp/honeycomb/vbd/api/target/generated-classes/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/vbridge/topology/rev160129/network/topology/topology/tunnel/parameters/vxlan/Vxlan.java:41: warning: no @return
      [WARNING] VxlanVni getVni();
      [WARNING] ^

      The solution is to generate:

      @return container foo, or null if not present

      or

      @return leaf bar, or null if not present

      and similar.

            Unassigned Unassigned
            martin.ciglan Martin Ciglan
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: