|author||fwienber <email@example.com>||Wed Nov 20 13:14:16 2019 +0100|
|committer||fwienber <firstname.lastname@example.org>||Wed Nov 20 13:14:16 2019 +0100|
[MJAVADOC-620] Integration test for class in top-level package The first case in which the module info retrieval fails is a JAR containing a class in the top-level package. This is the originally reported case in the JIRA ticket MJAVADOC-620. The FindException has a root cause that says that the usage of top-level packages is not allowed in modules. For the test, it is important to build the JAR in a Maven module that is *not* part of the Reactor. Otherwise, javadoc:aggregate would use the sources of class Test directly and the bug would not occur. This has been achieved by *not* adding the test project maven-MJAVADOC620-jar as a <module> to the main project. Instead, in invoker.properties, the first project is built using option -f. Note: The artifactId may not be maven-MJAVADOC-620-jar (with a dash before the issue number), because then, the module info retrieval fails for another reason, namely not being able to derive a module name. This is tested by an upcoming second integration test. Without the fix, maven-MJAVADOC620-jar-1.0-SNAPSHOT.jar is not added to the classpath and building the JavaDoc fails, because class Test is not found. With the fix, maven-MJAVADOC620-jar-1.0-SNAPSHOT.jar is added to the classpath and building the JavaDoc succeeds.
You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code, there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
Some of the ideas are documented in the Maven Wiki which might be interesting to read and for further discussion.
We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
git diff --checkbefore committing.
[MJAVADOC-XXX] - Subject of the JIRA Ticket Optional supplemental description.
mvn -Prun-its verifyto assure nothing else was accidentally broken.
If you plan to contribute on a regular basis, please consider filing a contributor license agreement.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. In this case, it is appropriate to start the first line of a commit with ‘(doc)’ instead of a ticket number.