Google Git
Sign in
apache / maven-javadoc-plugin / dd350edce1afa64aa15f34358200b2067bbc97ef
commitdd350edce1afa64aa15f34358200b2067bbc97ef[log] [tgz]
authorHenning Schmiedehausen <henning@schmiedehausen.org>Wed Sep 06 13:34:03 2023 -0700
committerGitHub <noreply@github.com>Wed Sep 06 13:34:03 2023 -0700
tree77ed730074c53d1eb2600315627edf7e8b2722f8
parent89316c9d47909a5ab1d6a97c056598a63eb2a667 [diff]
[MJAVADOC-770] Implement legacy mode for Java 9+ (#228)

A lot of existing projects that don't use module descriptors but only
automatic module naming have moved past Java 8. However, when trying
to build docs, the javadoc plugin assumes that the project is
modularized and starts using the module path which leads to problems
with documentation generation.

This change introduces a new configuration setting `<legacyMode>`
which is turned off by default. When turning on, the javadoc plugin
will continue to construct just a classpath (and not a module path)
for the javadoc tool, even if the jdk version is 9 or greater.

Includes integration test and documentation.
5 files changed
tree: 77ed730074c53d1eb2600315627edf7e8b2722f8
  1. .github/
  2. src/
  3. .asf.yaml
  4. .gitignore
  5. Jenkinsfile
  6. pom.xml
  7. README.md
README.md

Contributing to Apache Maven Javadoc Plugin

ASF Jira Apache License, Version 2.0, January 2004 Maven Central Reproducible Builds 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.

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