Uploaded image for project: 'UIMA'
  1. UIMA
  2. UIMA-4934

Detect license text in JavaDoc

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: uimaFIT-Maven-Plugin
    • Labels:
      None

      Description

      The uimaFIT maven plugin tries to pick up the documentation of a component from the JavaDoc of the implementing class. However, if there is no JavaDoc for the class, but there is a JavaDoc-like license header at the beginning of the file, then this license header is picked up again.

      This can be fixed by:

      • adding JavaDoc for the class
      • using a line-comment or block-comment for the license header instead of a `/**`-like JavaDoc block

      Another option (which this bug is for) is for the uimaFIT plugin to allow configuring a regular expression which is matched against the JavaDoc comment. If the regex matches, then the JavaDoc would be classified as a license (or potentially other non-documentation item) and would be ignored. E.g.

                      <plugin>
                          <groupId>org.apache.uima</groupId>
                          <artifactId>uimafit-maven-plugin</artifactId>
                          <configuration>
                              <ignoreJavaDocMatching>.*Licensed to.*</ignoreJavaDocMatching>
                          </configuration>
      

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              rec Richard Eckart de Castilho
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: