You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "ammachado (via GitHub)" <gi...@apache.org> on 2026/06/21 05:20:58 UTC

[PR] CAMEL-23535: camel-api - batches 21-25: enhance class-level Javadoc for DI, lifecycle, configurer, properties, and resource SPIs [camel]

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

   # Description
   
   Continues [CAMEL-23535](https://issues.apache.org/jira/browse/CAMEL-23535).
   
   This PR covers batches 21-25: **28 files** in `core/camel-api` received enhanced class-level Javadoc. The changes are documentation-only; no method signatures, annotations, or production code were altered.
   
   **Batch 21 — Bean post-processing and DI SPIs** (`spi/`)
   `CamelBeanPostProcessor`, `CamelBeanPostProcessorInjector`, `CamelDependencyInjectionAnnotationFactory`, `Injector`, `DependencyStrategy`
   
   **Batch 22 — CamelContext lifecycle event SPIs** (`spi/`)
   `OnCamelContextEvent` and its six phase sub-interfaces: `OnCamelContextInitializing`, `OnCamelContextInitialized`, `OnCamelContextStarting`, `OnCamelContextStarted`, `OnCamelContextStopping`, `OnCamelContextStopped`
   
   **Batch 23 — Property configurer SPIs** (`spi/`)
   `PropertyConfigurer`, `PropertyConfigurerAware`, `PropertyConfigurerGetter`, `ExtendedPropertyConfigurerGetter`, `GeneratedPropertyConfigurer`
   
   **Batch 24 — Properties source SPIs** (`spi/`)
   `PropertiesSource`, `PropertiesSourceFactory`, `LoadablePropertiesSource`, `PropertiesResolvedValue`, `PropertiesReload`
   
   **Batch 25 — Resource loading SPIs** (`spi/`)
   `Resource`, `ResourceAware`, `ResourceLoader`, `ResourceResolver`, `ResourceReload`, `ResourceReloadStrategy`
   
   Each file received:
   - A clear opening sentence naming its role in the Camel system
   - An architecture paragraph with `{@link}` references and explanation of callers/lifecycle
   - A user-manual `<a href>` link where a matching page exists (`property-binding`, `using-propertyplaceholder`, `route-reload`, `bean-injection`, `bean-integration`, `lifecycle`)
   - `@see` tags for closely related sibling types
   - Preserved `@since` tags
   
   While reworking `OnCamelContextEvent`, two dangling `@see` references to the non-existent `OnCamelContextStart` and `OnCamelContextStop` types were removed. The four core resource types (`Resource`, `ResourceAware`, `ResourceLoader`, `ResourceResolver`) intentionally omit an `<a href>` because no matching user-manual page exists.
   
   Verification performed 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-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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-23535: camel-api - batches 21-25: enhance class-level and method-level Javadoc for DI, lifecycle, configurer, properties, and resource SPIs [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24157:
URL: https://github.com/apache/camel/pull/24157#issuecomment-4761069346

   <!-- ci-tested-modules -->
   :test_tube: **CI tested the following changed modules:**
   
   - `core/camel-api`
   
   > :information_source: 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.
   
   ---
   :gear: [View full build and test results](https://github.com/apache/camel/actions/runs/27894852896)


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-23535: camel-api - batches 21-25: enhance class-level and method-level Javadoc for DI, lifecycle, configurer, properties, and resource SPIs [camel]

Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #24157:
URL: https://github.com/apache/camel/pull/24157


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-23535: camel-api - batches 21-25: enhance class-level and method-level Javadoc for DI, lifecycle, configurer, properties, and resource SPIs [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24157:
URL: https://github.com/apache/camel/pull/24157#issuecomment-4761038261

   :star2: Thank you for your contribution to the Apache Camel project! :star2:
     :robot: CI automation will test this PR automatically.
   
     :camel: 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](https://camel.apache.org/community/team/#committers) have access to the summary.
     
     :warning: Be careful when sharing logs. Review their contents before sharing them publicly.


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org