[
https://issues.apache.org/jira/browse/NUMBERS-144?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17036357#comment-17036357
]
Alex Herbert commented on NUMBERS-144:
--------------------------------------
The warnings are for the JMH module as a lot of the benchmark methods do not
have javadoc. This is deliberate and commented in the classes. Adding them
would be noise as the methods are supposed to have a self-documenting name. I
can fix this if you prefer.
In checking this I found Matt's error:
{noformat}
# Fine
mvn javadoc:javadoc -Pcommons-numbers-examples
# Errors
mvn javadoc:javadoc
{noformat}
Apache rat check thinks the examples modules is not a maven module and does not
apply the exclusions granted to a module based on the .gitignore file.
I've updated master with wildcards in the .gitignore for the relevant
resources. This avoids the alternative which is a lot of configuration in the
pom.xml for the rat plugin which has to be duplicated in the build and report
sections.
> Rat check fails on examples module files
> ----------------------------------------
>
> Key: NUMBERS-144
> URL: https://issues.apache.org/jira/browse/NUMBERS-144
> Project: Commons Numbers
> Issue Type: Task
> Reporter: Matt Juntunen
> Priority: Trivial
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The rat check can fail due to the presence of generated files from the
> examples module. For example, the following files caused the rat check to
> fail on my machine:
> {noformat}
> commons-numbers-examples/examples-jmh/target/rat.txt
> commons-numbers-examples/examples-jmh/target/osgi/MANIFEST.MF
> commons-numbers-examples/examples-jmh/.classpath
> commons-numbers-examples/examples-jmh/.settings/org.eclipse.m2e.core.prefs
> commons-numbers-examples/examples-jmh/.settings/org.eclipse.jdt.core.prefs
>
> commons-numbers-examples/examples-jmh/.settings/org.eclipse.core.resources.prefs
> commons-numbers-examples/examples-jmh/.project
> commons-numbers-examples/.settings/org.eclipse.m2e.core.prefs
> commons-numbers-examples/.settings/org.eclipse.core.resources.prefs
> commons-numbers-examples/.project
> {noformat}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
