CAMEL-23535: camel-api - batch 3: enhance class-level javadoc for endpoint/component/producer/consumer types#23430
Merged
Merged
Conversation
…point/component/producer/consumer types Expanded class-level javadoc for 24 types in the endpoint, component, producer, and consumer family. Major rewrites for Producer, Consumer, AsyncProducer, AsyncEndpoint, BatchConsumer, DelegateEndpoint, DelegateProcessor, and ApiEndpoint. Cross-links added via @see tags for all files; @see-only additions for already-rich types (Processor, AsyncProcessor, AsyncCallback, PollingConsumer, Channel, MultipleConsumersSupport, ShutdownRoute, ShutdownRunningTask). Comment-only change; no production code or signatures modified. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED
davsclaus
approved these changes
May 21, 2026
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
Contributor
|
🧪 CI tested the following changed modules:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Batch 3 of the CAMEL-23535 javadoc enhancement series. This PR improves class-level javadoc for 24 types in the endpoint, component, producer, and consumer family in
core/camel-api/src/main/java/org/apache/camel/.Changes by type:
Producer,Consumer,AsyncProducer,AsyncEndpoint,BatchConsumer,DelegateEndpoint,DelegateProcessor,ApiEndpoint,ComponentAware,EndpointAwareComponent,DynamicPollingConsumer,ResolveEndpointFailedException,NoSuchEndpointException,FailedToCreateRouteFromTemplateException@see-tag additions only (already had rich prose):Endpoint,Processor,AsyncProcessor,AsyncCallback,PollingConsumer,Channel,MultipleConsumersSupport,ShutdownRoute,ShutdownRunningTaskThis is a comment-only change. No production code, method signatures, or annotations are modified.
Related PRs in this series:
Claude Code on behalf of Adriano Machado
Target
mainbranch)Tracking
Apache Camel coding standards and style
mvn clean install -DskipTestslocally from root folder and I have committed all auto-generated changes.