ammachado opened a new pull request, #24158:
URL: https://github.com/apache/camel/pull/24158

   # Description
   
   Continues [CAMEL-23535](https://issues.apache.org/jira/browse/CAMEL-23535).
   
   This PR covers batches 26-30: **24 files** in `core/camel-api` (package 
`org.apache.camel.spi`) received enhanced **class-level and method-level** 
Javadoc. The changes are documentation-only; no method signatures, annotations, 
or production code were altered.
   
   **Batch 26 — Customizer SPIs**
   `CamelContextCustomizer`, `ComponentCustomizer`, `DataFormatCustomizer`, 
`LanguageCustomizer`, `CamelContextNameStrategy`
   
   **Batch 27 — Context tracking and reload SPIs**
   `CamelContextTracker` (incl. the `Filter` interface and the static notify 
methods), `ContextReloadStrategy`, `ReloadStrategy`, `BootstrapCloseable`, 
`StartupConditionStrategy`
   
   **Batch 28 — Data type and transformation SPIs**
   `Contract`, `DataTypeTransformer`, and a user-manual link added to `DataType`
   
   **Batch 29 — Id/group marker SPIs**
   `HasId`, `HasGroup`, `IdAware`, `RouteIdAware`, `StepIdAware`, `GroupAware`
   
   **Batch 30 — Interceptor SPIs**
   `InterceptStrategy`, `InterceptableProcessor`, `InterceptEndpointFactory`, 
`InterceptSendToEndpoint`, `AutoMockInterceptStrategy`
   
   Each file received:
   - **Class-level**: an opening sentence naming its role, an architecture 
paragraph with `{@link}` references and explanation of callers/lifecycle, a 
user-manual `<a href>` link where a matching page exists 
(`camelcontext-autoconfigure`, `context-reload`, `transformer`), `@see` 
cross-references, and preserved `@since` tags.
   - **Method-level**: documentation added for the public methods that were 
undocumented or terse (e.g. `CamelContextTracker`'s `Filter`/static notify 
methods, `Contract` getters). Method Javadoc that was already adequate was left 
unchanged, per the agreed gaps-only approach.
   
   Several types in these themes already had complete Javadoc (e.g. `DataType`, 
`DataTypeAware`, `TransformerLoader`, `TransformerResolver`, 
`ContextServicePlugin`, `ContextServiceLoaderPluginResolver`) and were 
intentionally left untouched. Marker/identity SPIs with no matching user-manual 
page intentionally omit an `<a href>`.
   
   Verification for each batch: style matched against previously enhanced 
files, `mvn formatter:format impsort:sort` touched only the intended files, and 
`mvn compile` on `core/camel-api` passed. Class- and method-level Javadoc does 
not affect generated catalog files, so no generated changes were produced.
   
   # 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 (usually before you start working on it).
   
   # 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 formatter:format impsort:sort` and `mvn compile` on 
`core/camel-api` locally and committed all changes. (Documentation-only change; 
no auto-generated files are affected.)
   
   _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]

Reply via email to