camel icon indicating copy to clipboard operation
camel copied to clipboard

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

Open apupier opened this issue 1 year ago • 2 comments

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: https://github.com/apache/camel/blob/0c63d15314d90e03da251214c7f9e12bf0f938dd/pom.xml#L714

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.

apupier avatar Oct 16 '24 14:10 apupier

:star2: Thank you for your contribution to the Apache Camel project! :star2:

:robot: CI automation will test this PR automatically.

:camel: 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.

  • :warning: Be careful when sharing logs. Review their contents before sharing them publicly.

github-actions[bot] avatar Oct 16 '24 14:10 github-actions[bot]

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 avatar Oct 16 '24 15:10 apupier

closing old and stale PR

davsclaus avatar Oct 02 '25 09:10 davsclaus