lobtx opened a new pull request, #30183:
URL: https://github.com/apache/camel/pull/30183
# Description
Follow-up of #30121, and the last module of this series: makes the Javadoc
of `core/camel-api` pass doclint (`-Xdoclint:all,-missing`). The diff is large
but mostly mechanical.
- replace `<tt>` (not supported in HTML5) with `<code>`, self-closing `<p/>`
and `<br/>` with `<p>` and `<br>`; this includes `tooling/spi-annotations`,
which camel-api copies into `src/generated` (both are committed)
- repair broken HTML: stray `</p>`, unclosed `<code>`, `{@Link}`, `<h3>` out
of sequence, unescaped `&`
- references to classes that are not visible from camel-api (camel-support,
camel-core-processor, camel-core-model, camel-management...) use `{@code}`
instead of `{@link}`; `@see` tags pointing to them are removed or moved into
the text
- fix wrong references (`org.apache.camel.spi.TypeConverter` ->
`org.apache.camel.TypeConverter`,
`org.apache.camel.processor.aggregate.AggregationStrategy` ->
`org.apache.camel.AggregationStrategy`, `BacklogTracer#dumpTracedMessagesAs*`
signatures, `{@link List}` without import)
- `ServiceHelper#resumeService`/`suspendService`: remove `@throws
Exception`, as they do not throw it
- fix pre-existing wording in the touched Javadoc blocks (grammar, typos,
missing periods, a few copy-pasted descriptions such as `Resource#getURL`,
`RouteController#adapt`, `KeyStoreParameters#createKeyStore`)
Javadoc only, no code change. The Javadoc of `RestConfiguration` is copied
into the camel-main configuration metadata, so
`camel-main-configuration-metadata.json` and `main.adoc` are regenerated
(`camel.rest.enableCORS` and `camel.rest.producerApiDoc`), together with their
copies in camel-catalog. No other generated file changes (checked with a clean
build of camel-api and camel-main).
Checked with `mvn -pl core/camel-api javadoc:javadoc -Ddoclint=all,-missing`.
AI tool used: Claude Code (Claude Opus 5.5), reviewed and checked by me.
_Claude Code on behalf of lobtx_
🤖 Generated with [Claude Code](https://claude.com/claude-code)
--
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]