Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAMEL-21190 - Configure Maven Javadoc Plugin for Java version used for compilation #15983

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

apupier
Copy link
Contributor

@apupier apupier commented Oct 16, 2024

Description

it requires then to not use the doclint as there are a bunch of invalid or no more valid Javadoc in the codebase.

It was already used and mentioned as a workaround for one of the configuration of the maven-javadoc-plugin:

camel/pom.xml

Line 714 in 0c63d15

<doclint>none</doclint>

reported https://issues.apache.org/jira/browse/CAMEL-21356 to fix the Javadoc issues

to test locally (at least a part of the changes), we can call mvn javadoc:javadoc

Target

  • I checked that the commit is targeting the correct branch (note that Camel 3 uses camel-3.x, whereas Camel 4 uses the main branch)

Tracking

  • If this is a large change, bug fix, or code improvement, I checked there is a JIRA issue filed for the change (usually before you start working on it).

Apache Camel coding standards and style

  • I checked that each commit in the pull request has a meaningful subject line and body.
  • I have run mvn clean install -DskipTests locally from root folder and I have committed all auto-generated changes.

compilation

it requires then to not use the doclint as there are a bunch of invalid
or no more valid Javadoc in the codebase

Signed-off-by: Aurélien Pupier <[email protected]>
Copy link
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟

🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run

  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot.

  • You can label PRs using build-all, build-dependents, skip-tests and test-dependents to fine-tune the checks executed by this PR.

  • Build and test logs are available in the Summary page. Only Apache Camel committers have access to the summary.

  • ⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@@ -3546,12 +3546,12 @@
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<attach>true</attach>
<source>${jdk.version}</source>
<release>${maven.javadoc.release}</release>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understood well, we should be able to even not provide the release version now as it would pick it up from maven-compiler.release https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#release
But maybe better to keep it for now to have a finer grained control.

@apupier
Copy link
Contributor Author

apupier commented Oct 16, 2024

mvn javadoc:javadoc currently failing with:

[�[1;31mERROR�[m] �[1;31m/home/apupier/git/camel/components/camel-infinispan/camel-infinispan/src/main/java/org/apache/camel/component/infinispan/remote/InfinispanRemoteAggregationRepository.java:22: error: cannot find symbol�[m
[�[1;31mERROR�[m] �[1;31mimport org.apache.camel.component.infinispan.remote.protostream.DefaultExchangeHolderContextInitializer;�[m
[�[1;31mERROR�[m] �[1;31m                                                               ^�[m
[�[1;31mERROR�[m] �[1;31m  symbol:   class DefaultExchangeHolderContextInitializer�[m
[�[1;31mERROR�[m] �[1;31m  location: package org.apache.camel.component.infinispan.remote.protostream

EDIT: reproducing this erro ron main branch when setting the doclint to none too (otherwise failing sooner). So wondering how the javadoc is currently generated oO . About the error in itself the mentioned class is available in target/generated-sources but not in src/generated/sources

@apupier apupier marked this pull request as draft October 18, 2024 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant