Uploaded image for project: 'Daffodil'
  1. Daffodil
  2. DFDL-1380

Update genjavadoc plugin to 10 when released and enable doclint

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: deferred
    • Component/s: API, Infrastructure
    • Labels:
      None

      Description

      The Java 8 javadoc tool has a feature called -Xdoclint, which performs extra checks on the javadoc. One of these checks is to ensure that any @throws tags in the javadoc have a corresponding throws clause in Java. For example

      /**
       * Function that throws exceptions
       *
       * @throws IOException when io is bad
       * @returns foo
       */
      void function() throws IOException { ... }

      However, version 9 of the genjavadoc plugin did not generate the throws clause for the scala @throws attribute. So, the generated java code failed the doclint checks. To get around this, doclint was turned off in commit 124151db82add3f2494f32818c29755d64b98f3c of DFDL-1367.

      Version 10 of the plugin will have support for generating the throws clause from scala @throws annotations. When that is released we should update to that and enable the doclint javadoc feature.

        Gliffy Diagrams

          Attachments

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              slawrence Steve Lawrence
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Tasks

                  Progress: 
                   0/0