CAMEL-23535: camel-api - batches 26-30: enhance class-level and method-level Javadoc for customizer, reload, data-type, marker, and interceptor SPIs#24158
Conversation
Enhance class-level Javadoc (method docs were already adequate) for the configuration customizer SPIs in org.apache.camel.spi: CamelContextCustomizer, ComponentCustomizer, DataFormatCustomizer, LanguageCustomizer, and CamelContextNameStrategy. Adds role/architecture detail, the camelcontext-autoconfigure user-manual link, and @see cross-references. Documentation-only; no production code or signatures changed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ng and reload SPIs Enhance class-level Javadoc, and add the few missing method docs, for org.apache.camel.spi: CamelContextTracker (incl. the Filter interface and the static notify methods), ContextReloadStrategy, ReloadStrategy, BootstrapCloseable, and StartupConditionStrategy. Adds the context-reload user-manual link where applicable. Documentation-only; no production code or signatures changed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…transformation SPIs Enhance Javadoc for org.apache.camel.spi: Contract (class-level plus @return on the getters), DataTypeTransformer (class-level), and add the transformer user-manual link to DataType. DataTypeAware, TransformerLoader, and TransformerResolver already had adequate docs and were left unchanged. Documentation-only; no production code or signatures changed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…/group marker SPIs Enhance class-level Javadoc (method docs were already adequate) for the identity marker SPIs in org.apache.camel.spi: HasId, HasGroup, IdAware, RouteIdAware, StepIdAware, and GroupAware. Adds role detail and @see cross-references between the markers and their settable counterparts. Documentation-only; no production code or signatures changed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…terceptor SPIs Enhance class-level Javadoc (method docs were already adequate) for the interception SPIs in org.apache.camel.spi: InterceptStrategy, InterceptableProcessor, InterceptEndpointFactory, InterceptSendToEndpoint, and AutoMockInterceptStrategy. Adds role/architecture detail and @see cross-references. Documentation-only; no production code or signatures changed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
davsclaus
left a comment
There was a problem hiding this comment.
Clean Javadoc-only PR covering batches 26-30 of CAMEL-23535. All 24 files are documentation improvements with no production code or signature changes. <p/> style is consistent with the codebase, user-manual links resolve correctly, @since tags are preserved, and @see cross-references are bidirectional where appropriate. LGTM.
This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.
|
🧪 CI tested the following changed modules:
|
Description
Continues CAMEL-23535.
This PR covers batches 26-30: 24 files in
core/camel-api(packageorg.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,CamelContextNameStrategyBatch 27 — Context tracking and reload SPIs
CamelContextTracker(incl. theFilterinterface and the static notify methods),ContextReloadStrategy,ReloadStrategy,BootstrapCloseable,StartupConditionStrategyBatch 28 — Data type and transformation SPIs
Contract,DataTypeTransformer, and a user-manual link added toDataTypeBatch 29 — Id/group marker SPIs
HasId,HasGroup,IdAware,RouteIdAware,StepIdAware,GroupAwareBatch 30 — Interceptor SPIs
InterceptStrategy,InterceptableProcessor,InterceptEndpointFactory,InterceptSendToEndpoint,AutoMockInterceptStrategyEach file received:
{@link}references and explanation of callers/lifecycle, a user-manual<a href>link where a matching page exists (camelcontext-autoconfigure,context-reload,transformer),@seecross-references, and preserved@sincetags.CamelContextTracker'sFilter/static notify methods,Contractgetters). 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:sorttouched only the intended files, andmvn compileoncore/camel-apipassed. Class- and method-level Javadoc does not affect generated catalog files, so no generated changes were produced.Target
mainbranch)Tracking
Apache Camel coding standards and style
mvn formatter:format impsort:sortandmvn compileoncore/camel-apilocally and committed all changes. (Documentation-only change; no auto-generated files are affected.)Claude Code on behalf of Adriano Machado