Skip to content

CAMEL-23535: camel-api - batch 3: enhance class-level javadoc for endpoint/component/producer/consumer types#23430

Merged
davsclaus merged 1 commit into
apache:mainfrom
ammachado:CAMEL-23535
May 21, 2026
Merged

CAMEL-23535: camel-api - batch 3: enhance class-level javadoc for endpoint/component/producer/consumer types#23430
davsclaus merged 1 commit into
apache:mainfrom
ammachado:CAMEL-23535

Conversation

@ammachado
Copy link
Copy Markdown
Contributor

@ammachado ammachado commented May 21, 2026

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:

  • Major rewrites (minimal or missing javadoc before): Producer, Consumer, AsyncProducer, AsyncEndpoint, BatchConsumer, DelegateEndpoint, DelegateProcessor, ApiEndpoint, ComponentAware, EndpointAware
  • Moderate expansion (terse opener + added context): Component, DynamicPollingConsumer, ResolveEndpointFailedException, NoSuchEndpointException, FailedToCreateRouteFromTemplateException
  • @see-tag additions only (already had rich prose): Endpoint, Processor, AsyncProcessor, AsyncCallback, PollingConsumer, Channel, MultipleConsumersSupport, ShutdownRoute, ShutdownRunningTask

This 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

  • I checked that the commit is targeting the correct branch (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.

…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
@ammachado ammachado marked this pull request as ready for review May 21, 2026 14:59
@davsclaus davsclaus merged commit 0c81b8a into apache:main May 21, 2026
6 checks passed
@ammachado ammachado deleted the CAMEL-23535 branch May 21, 2026 17:28
@github-actions
Copy link
Copy Markdown
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 although they are normally detected and executed by CI.
  • You can label PRs using 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.

@github-actions github-actions Bot added the core label May 21, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • core/camel-api

ℹ️ Dependent modules were not tested because the total number of affected modules exceeded the threshold (50). Use the test-dependents label to force testing all dependents.


⚙️ View full build and test results

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants