ammachado opened a new pull request, #23720: URL: https://github.com/apache/camel/pull/23720
# 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 4** of that work. Batches 1, 2, and 3 are already merged. | Batch | PR | Scope | |---|---|---| | 1 | #23311 | Lifecycle and context types | | 2 | #23330 | Messaging core types | | 3 | #23430 | Endpoint, component, producer, consumer types | | **4** | **this PR** | **Routes, builders, startup, management, cross-cutting** | ## Changes Class-level Javadoc expanded on 22 top-level types in `org.apache.camel`: **Routes and builders:** `Route`, `RoutesBuilder`, `RouteConfigurationsBuilder`, `RouteTemplateContext`, `RouteAware`, `NamedNode`, `NamedRoute`, `Navigate`, `RuntimeConfiguration`, `ErrorHandlerFactory` **Lifecycle, startup, and management:** `VetoCamelContextStartException`, `StartupStep`, `StartupSummaryLevel`, `ExtendedStartupListener`, `NonManagedService` **Shared cross-cutting types:** `Builder`, `LoggingLevel`, `ManagementMBeansLevel`, `ManagementStatisticsLevel`, `Ordered`, `Traceable`, `TimerListener` Each updated docblock follows the same pattern established in the previous batches: a one-sentence what-it-is opener, a paragraph on the role in routing / lifecycle, sibling-type `{@link}` references, and (where a matching user-manual page exists) one `<a href>` link. The change is **comment-only**: no signatures, behaviour, or runtime code is altered. ## Out of scope (follow-ups under CAMEL-23535) - Batch 5: annotation and injection types (`BeanInject`, `Body`, `Header`, `Produce`, `Consume`, etc.) — ~20 types - Batch 6: expression, predicate, and type-conversion types — ~10 types - Batch 7+: remaining top-level types and `org.apache.camel.spi` package (266 files) # 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 formatter:format impsort:sort` locally and committed all 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]
