[MDSAL-150] Java Binding: missing @return (binding spec. v2) Created: 05/Apr/16  Updated: 16/Mar/19  Resolved: 16/Mar/19

Status: Resolved
Project: mdsal
Component/s: Binding V2 codegen
Affects Version/s: None
Fix Version/s: None

Type: Bug
Reporter: Martin Ciglan Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All

Issue Links:
Blocks
is blocked by MDSAL-237 Milestone: Implement Binding Specific... Resolved
External issue ID: 5671

 Description   

+++ 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.

 Comments   
Comment by Robert Varga [ 16/Mar/19 ]

Binding V2 is being removed in 4.0.0.

Generated at Wed Feb 07 20:08:46 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.