Richard Eckart de Castilho created UIMA-4934:
------------------------------------------------
Summary: Detect license text in JavaDoc
Key: UIMA-4934
URL: https://issues.apache.org/jira/browse/UIMA-4934
Project: UIMA
Issue Type: Improvement
Components: uimaFIT-Maven-Plugin
Reporter: Richard Eckart de Castilho
Fix For: 2.3.0uimaFIT
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.
{noformat}
<plugin>
<groupId>org.apache.uima</groupId>
<artifactId>uimafit-maven-plugin</artifactId>
<configuration>
<ignoreJavaDocMatching>.*Licensed
to.*</ignoreJavaDocMatching>
</configuration>
{noformat}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
