[UIMA-4934] Detect license text in JavaDoc

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Won't Fix
• Component/s: uimaFIT-Maven-Plugin
• Assignee: Unassigned
• Reporter: Richard Eckart de Castilho
• Created: 14/May/16 15:07
• Updated: 07/Jul/18 21:31
• Resolved: 07/Jul/18 21:31

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>