ammachado opened a new pull request, #23330: URL: https://github.com/apache/camel/pull/23330
# Description [CAMEL-23535](https://issues.apache.org/jira/browse/CAMEL-23535) asks for an audit and enhancement of the javadoc in `core/camel-api` so that classes better explain what they are, what they do, and how they fit into the framework, with links to the relevant user-manual pages. This PR is **batch 2** of that work: class-level javadoc on the **messaging core** family of top-level public-API types. Batch 1 (lifecycle and context) was merged as PR #23311. ## Changes Class-level javadoc expanded on 18 top-level types in `org.apache.camel`: - **Core messaging:** `Exchange`, `ExchangeExtension`, `ExchangePattern`, `ExchangePropertyKey`, `Message`, `MessageHistory`, `StreamCache`, `WrappedFile` - **Exceptions:** `RuntimeExchangeException`, `InvalidPayloadException`, `InvalidPayloadRuntimeException`, `NoSuchHeaderException`, `NoSuchHeaderOrPropertyException`, `NoSuchPropertyException`, `NoTypeConversionAvailableException`, `TypeConversionException`, `RollbackExchangeException`, `ValidationException` Notable improvements: - `ExchangeExtension`: the class-level comment was a plain `/* */` block (invisible to javadoc tooling); converted to `/** */` and expanded. - `ExchangePattern`: terse one-liner expanded to explain InOnly vs InOut with their routing semantics. - `WrappedFile`: expanded from "Wraps a file." to describe the file-oriented consumer abstraction. - Exception types: each now states clearly what condition triggers it and, where applicable, links to its checked/unchecked counterpart. Each updated docblock follows the same pattern: a one-sentence what-it-is opener, a paragraph on the role in routing, sibling-type `{@link}` references. The convention matches the existing javadoc style in `Endpoint.java`, `Component.java`, `Processor.java`, `Message.java`, `Route.java`. The change is **comment-only**: no signatures, behaviour, or runtime code is altered. ## Out of scope (follow-ups under CAMEL-23535) - Remaining top-level `org.apache.camel.*` types: endpoints/components/producers/consumers (batch 3), routes and builders (batch 4), annotations and functional types (batch 5). - Public-method javadoc gap-filling. - `org.apache.camel.spi.*` and other sub-packages. # Target - [x] I checked that the commit is targeting the correct branch (Camel 4 uses the `main` branch) # Tracking - [x] If this is a large change, bug fix, or code improvement, I checked there is a [JIRA issue](https://issues.apache.org/jira/browse/CAMEL-23535) filed for the change. # Apache Camel coding standards and style - [x] I checked that each commit in the pull request has a meaningful subject line and body. - [x] I have run \`mvn clean install -DskipTests\` locally from root folder and I have committed all auto-generated changes. --- _Claude Code on behalf of Adriano Machado_ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
