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

Generate javadoc for unions

    XMLWordPrintable

Details

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

    Description

      Modern default doclet generates this warning:

      [WARNING] /home/nite/odl/mdsal/binding/mdsal-binding-test-model/target/generated-sources/BindingJavaFileGenerator/org/opendaylight/yang/gen/v1/bug8449/rev170516/ContInt32.java:44: warning: no comment
      [WARNING] public static final class RefUnionInt32
      [WARNING] ^
      

      This is because the union class does not have any javadoc at all. In this particular case the encapsulating type already javadoc:

      /**
       *
       * <p>
       * This class represents the following YANG schema fragment defined in module <b>bug8449</b>
       * <pre>
       * container cont-int32 {
       *   leaf ref-union-int32 {
       *     type union {
       *       type int32-ref;
       *     }
       *   }
       * }
       * </pre>
       * <p>To create instances of this class use {@link ContInt32Builder}.
       * @see ContInt32Builder
       *
       */
      

      In this particular case we want to generate a similar comment and quote the 'leaf ref-union-int32' part of the YANG snippet.

      Attachments

        Issue Links

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

          Activity

            People

              SamoSchneider Samuel Schneider
              rovarga Robert Varga
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: