https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/MDSAL-402 mdsal <p>javadoc does not like us not generating @param/@return for RPC methods:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>00:07:16.928 [WARNING] /w/workspace/controller-maven-verify-fluorine-mvn35-openjdk8/opendaylight/md-sal/samples/clustering-test-app/model/target/generated-sources/mdsal-binding/org/opendaylight/yang/gen/v1/tag/opendaylight/org/_2017/controller/yang/lowlevel/control/rev170215/OdlMdsalLowlevelControlService.java:412: warning: no @param for input 00:07:16.929 [WARNING] ListenableFuture&lt;RpcResult&lt;ShutdownShardReplicaOutput&gt;&gt; shutdownShardReplica(ShutdownShardReplicaInput input); 00:07:16.929 [WARNING] ^ 00:07:16.929 [WARNING] /w/workspace/controller-maven-verify-fluorine-mvn35-openjdk8/opendaylight/md-sal/samples/clustering-test-app/model/target/generated-sources/mdsal-binding/org/opendaylight/yang/gen/v1/tag/opendaylight/org/_2017/controller/yang/lowlevel/control/rev170215/OdlMdsalLowlevelControlService.java:412: warning: no @return 00:07:16.929 [WARNING] ListenableFuture&lt;RpcResult&lt;ShutdownShardReplicaOutput&gt;&gt; shutdownShardReplica(ShutdownShardReplicaInput input); 00:07:16.929 [WARNING] ^</pre> </div></div> <p>improve codegen to fill those in.</p> MDSAL-402

Generate @param for RPC invocation methods

Improvement Medium Resolved Done Ilya Igushev Robert Varga pt Mon, 26 Nov 2018 21:38:08 +0000 Fri, 9 Oct 2020 14:40:29 +0000 Fri, 9 Oct 2020 14:40:29 +0000 7.0.0 Binding codegen 0 1 <p>I think this will need a bit of a rework of javadocs, as those are driven by 'description' statement. For these invocations, we really want to the javadoc to be composed of three things:</p> <ul> <li>a common header, like "Invoke {@code shutdown-shard-replica} RPC."</li> <li>a pre-formatted, description-based block</li> <li>a common footer, describing input/return/throw declarations</li> </ul> Development Rank 0|i03kzb: