Dhairya-007 opened a new pull request, #29647:
URL: https://github.com/apache/camel/pull/29647
Two classes of Javadoc defect that no check in the build catches.
### Duplicated words (18 places)
`not not`, `the the`, `a a`, `to to`, `from from`, `if if`, `and and`. Most
are harmless slips, but two changed the meaning of the sentence:
- `RedeliveryErrorHandler.getDefaultHandledPredicate` — "Default is **not
not** handle errors" now reads "Default is **to not** handle errors",
which is what returning `null` does.
- `DigitalSignatureConfiguration.setPrivateKey` — "the key **with with** to
sign the exchange" now reads "with **which** to sign".
The gson, jackson, jackson3 and jacksonxml entries are constructor Javadoc,
not option descriptions, so no generated descriptor carries them — checked
with a grep over `catalog/`.
### Javadoc `@param` names that no parameter has (4 methods)
| Method | Documented | Actual |
|---|---|---|
| `MavenGav.parseMavenResolverString` | `gav` | `gaecv` |
| `QuarkusHelper.findQuarkusPlatformBom` | `downloader`, "A
`MavenDownloader` to use for accessing" | `mavenResolver`, a
`Function<MavenGav, MavenArtifact>` |
| `QuarkusHelper.findPlatformBom` | `majorMinor`, `fieldName` |
`wantedCamelVersion`; `fieldName` no longer exists |
| `MajorMinor.distanceTo` | `thisVersion`, `otherVersion` | one parameter,
`other` |
`findPlatformBom` also claimed to return "the version string", while it
returns `Optional<QuarkusPlatformBom>`; `findQuarkusPlatformBom` had an empty
`@param quarkusExtensionRegistryBaseUri`, and `distanceTo` had empty tags
throughout. Those are filled in, and the two parameters `findPlatformBom`
never documented are added. The alignment column of each block is kept as the
formatter writes it.
### Left alone
- `XmlPullParser` — "TEXT **to to** a string" is in vendored xmlpull API
documentation; correcting it would diverge from upstream.
- `@param from from index of node…` in `AdviceWithBuilder` and
`CamelContext`, `in in-memory` in `ShutdownStrategy`, `in IN message` in
`SimpleCxfRsBinding`, and "disable reply to **to** avoid" in the JMS tests
are all correct as written.
--
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]
