Improve remaining Javadoc in camel-api: grammar, method docs, and exception constructors#23196
Merged
Merged
Conversation
…eption constructors - Fix grammar: RoutePolicyFactory, HeaderFilterStrategy, StreamCachingStrategy, ResumeAction, WritableHealthCheckRepository, CamelContext "its" -> "it's" - Improve SPI class docs: StreamCachingStrategy, RoutePolicyFactory - Add Javadoc to TypeConverter.MISS_VALUE and Experimental.revision() - Add method-level Javadoc to PropertiesValidationResult, VaultConfiguration, HealthCheckResultBuilder, ResumeStrategy, BaseService, RestConfiguration - Add @param tags to 24 remaining exception class constructors Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
davsclaus
approved these changes
May 13, 2026
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
Contributor
|
🧪 CI tested the following changed modules:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Final batch of Javadoc improvements for the camel-api module, addressing all remaining issues from the analysis:
Grammar and typo fixes:
RoutePolicyFactory: "automatic" -> "automatically" + added registration docsHeaderFilterStrategy: "plug-able" -> "pluggable", "filter header" -> "filter headers"StreamCachingStrategy: "aas" -> "as" (3x) + replaced tautological class docResumeAction: "and interface" -> "an interface"WritableHealthCheckRepository: fixed incorrect copy-paste class descriptionCamelContext: fixed 6 "its" -> "it's" (contraction) occurrencesUndocumented API elements:
TypeConverter.MISS_VALUE: added sentinel value descriptionExperimental.revision(): added annotation element descriptionMethod-level Javadoc added to 6 classes:
PropertiesValidationResult(42 methods)VaultConfiguration(28 methods)HealthCheckResultBuilder(14 methods)ResumeStrategy(2 methods)BaseService(32 methods)RestConfiguration(65 methods)Exception constructor @param tags:
All changes are Javadoc-only — no functional code modified. 38 files changed, 384 insertions.
Test plan
mvn install -pl core/camel-api -DskipTestspassesmvn formatter:format impsort:sort)