[MDSAL-402] Generate @param for RPC invocation methods Created: 26/Nov/18 Updated: 09/Oct/20 Resolved: 09/Oct/20 |
|
| Status: | Resolved |
| Project: | mdsal |
| Component/s: | Binding codegen |
| Affects Version/s: | None |
| Fix Version/s: | 7.0.0 |
| Type: | Improvement | Priority: | Medium |
| Reporter: | Robert Varga | Assignee: | Ilya Igushev |
| Resolution: | Done | Votes: | 0 |
| Labels: | pt | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
javadoc does not like us not generating @param/@return for RPC methods: 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<RpcResult<ShutdownShardReplicaOutput>> 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<RpcResult<ShutdownShardReplicaOutput>> shutdownShardReplica(ShutdownShardReplicaInput input); 00:07:16.929 [WARNING] ^ improve codegen to fill those in. |
| Comments |
| Comment by Robert Varga [ 08/Jan/19 ] |
|
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:
|