[MDSAL-483] Invalid javadoc for compatibility constructor involving uint and identityref

Blocks — Wed, 9 Oct 2019 09:30:05 +0000

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.

OpenDaylight JIRA

[MDSAL-483] Invalid javadoc for compatibility constructor involving uint and identityref