Skip to content

Improve remaining Javadoc in camel-api: grammar, method docs, and exception constructors#23196

Merged
gnodet merged 1 commit into
apache:mainfrom
gnodet:javadoc-api-remaining-fixes
May 13, 2026
Merged

Improve remaining Javadoc in camel-api: grammar, method docs, and exception constructors#23196
gnodet merged 1 commit into
apache:mainfrom
gnodet:javadoc-api-remaining-fixes

Conversation

@gnodet
Copy link
Copy Markdown
Contributor

@gnodet gnodet commented May 13, 2026

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 docs
  • HeaderFilterStrategy: "plug-able" -> "pluggable", "filter header" -> "filter headers"
  • StreamCachingStrategy: "aas" -> "as" (3x) + replaced tautological class doc
  • ResumeAction: "and interface" -> "an interface"
  • WritableHealthCheckRepository: fixed incorrect copy-paste class description
  • CamelContext: fixed 6 "its" -> "it's" (contraction) occurrences

Undocumented API elements:

  • TypeConverter.MISS_VALUE: added sentinel value description
  • Experimental.revision(): added annotation element description

Method-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:

  • Added to 24 remaining exception classes (CamelException, ValidationException, RollbackExchangeException, ExpressionEvaluationException, etc.)

All changes are Javadoc-only — no functional code modified. 38 files changed, 384 insertions.

Test plan

  • mvn install -pl core/camel-api -DskipTests passes
  • Formatter applied (mvn formatter:format impsort:sort)
  • No generated file changes needed

…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>
@gnodet gnodet requested review from davsclaus and oscerd May 13, 2026 15:49
@gnodet gnodet marked this pull request as draft May 13, 2026 15:56
@github-actions
Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 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 have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions github-actions Bot added the core label May 13, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • core/camel-api

ℹ️ 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.


⚙️ View full build and test results

@gnodet gnodet marked this pull request as ready for review May 13, 2026 23:52
@gnodet gnodet merged commit d1a92b1 into apache:main May 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants