[MDSAL-483] Invalid javadoc for compatibility constructor involving uint and identityref Created: 08/Oct/19  Updated: 09/Oct/19  Resolved: 09/Oct/19

Status: Resolved
Project: mdsal
Component/s: Binding codegen
Affects Version/s: 5.0.0, 5.0.1
Fix Version/s: 5.0.2

Type: Bug Priority: Highest
Reporter: Robert Varga Assignee: Robert Varga
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Blocks
blocks TSC-234 Milestone: Magnesium Release integrat... Closed

 Description   

This was detected in https://jenkins.opendaylight.org/releng/view/integration/job/integration-multipatch-test-magnesium/21 :

18:02:36 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:jar (attach-javadocs) on project itm-api: MavenReportException: Error while generating Javadoc: 
18:02:36 [ERROR] Exit code: 1 - /w/workspace/integration-multipatch-test-magnesium/patch_tester/genius/itm/itm-api/target/generated-sources/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/genius/itm/op/rev160406/tunnel/list/InternalTunnelKey.java:34: error: malformed HTML
18:02:36 [ERROR]      * @deprecated Use {#link InternalTunnelKey(Uint64, Uint64, Class<? extends TunnelTypeBase>)} instead.
18:02:36 [ERROR]                                                                      ^
18:02:36 [ERROR] /w/workspace/integration-multipatch-test-magnesium/patch_tester/genius/itm/itm-api/target/generated-sources/mdsal-binding/org/opendaylight/yang/gen/v1/urn/opendaylight/genius/itm/op/rev160406/tunnel/list/InternalTunnelKey.java:34: error: bad use of '>'
18:02:36 [ERROR]      * @deprecated Use {#link InternalTunnelKey(Uint64, Uint64, Class<? extends TunnelTypeBase>)} instead.
18:02:36 [ERROR]                                                                                               ^

The Class references are coming from identityrefs:

            container tunnel-list {
                list internal-tunnel {
                    key  "source-DPN destination-DPN transport-type";

                    leaf source-DPN {
                        type uint64;
                    }

                    leaf destination-DPN {
                        type uint64;
                    }

                    leaf transport-type {
                        type identityref {
                            base odlif:tunnel-type-base;
                        }
                    }

                    /* logical-group interface id */
                    leaf-list tunnel-interface-names {
                        type string;
                    }
                }      
            }

When we are referencing the type in javadoc we need to use the raw type.


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