Uploaded image for project: 'mdsal'
  1. mdsal
  2. MDSAL-402

Generate @param for RPC invocation methods

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved
    • Medium
    • Resolution: Done
    • None
    • 7.0.0
    • Binding codegen

    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.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            ilyaigushev Ilya Igushev
            rovarga Robert Varga
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: