Google Git
Sign in
apache / maven-javadoc-plugin / 769b73f5eeeb736f8f646ba080d7b788e54c6862
commit769b73f5eeeb736f8f646ba080d7b788e54c6862[log] [tgz]
authorfwienber <frank.wienberg@coremedia.com>Wed Nov 20 13:14:16 2019 +0100
committerfwienber <frank.wienberg@coremedia.com>Wed Nov 20 13:14:16 2019 +0100
treeb8862962d0aba3185a82169a7cdbc99491c4dae2
parente4efc0f184a75f852975a8c3318960b3f9391204 [diff]
[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.
6 files changed
tree: b8862962d0aba3185a82169a7cdbc99491c4dae2
  1. .github/
  2. src/
  3. .gitignore
  4. CONTRIBUTING.md
  5. Jenkinsfile
  6. pom.xml
  7. README.md
README.md

Contributing to Apache Maven JavaDoc Plugin

Apache License, Version 2.0, January 2004 Maven Central Jenkins Status Jenkins tests

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.

Getting Started

  • Make sure you have a JIRA account.
  • Make sure you have a GitHub account.
  • If you‘re planning to implement a new feature, it makes sense to discuss your changes on the dev list first. This way you can make sure you’re not wasting your time on something that isn‘t considered to be in Apache Maven’s scope.
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue, including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub.

Making and Submitting Changes

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:

  • Create a topic branch from where you want to base your work (this is usually the master branch). Push your changes to a topic branch in your fork of the repository.
  • Make commits of logical units.
  • Respect the original code style: by using the same codestyle, patches should only highlight the actual difference, not being disturbed by any formatting issues:
    • Only use spaces for indentation.
    • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted, create a separate PR for this change.
    • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
[MJAVADOC-XXX] - Subject of the JIRA Ticket
 Optional supplemental description.
  • Make sure you have added the necessary tests (JUnit/IT) for your changes.
  • Run all the tests with mvn -Prun-its verify to assure nothing else was accidentally broken.
  • Submit a pull request to the repository in the Apache organization.
  • Update your JIRA ticket and include a link to the pull request in the ticket.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement.

Making Trivial Changes

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.

Additional Resources