Dhairya-007 opened a new pull request, #29641:
URL: https://github.com/apache/camel/pull/29641
When a member is inserted between a Javadoc block and the member it was
written for, the file ends up with two `/** */` blocks in a row. Javadoc
keeps only the **last** block before a declaration, so the earlier one is
silently dropped from the generated documentation, and whatever it says is
attributed to the wrong member while reading the source.
A sweep for adjacent Javadoc blocks across the repository found eight such
cases outside the `camel-jbang` modules. Each one is fixed by moving the
block to the member it describes, not by deleting it.
| File | Block | Belongs to |
|---|---|---|
| `EndpointSchemaGeneratorMojo` | "Gets the default value accordingly to its
type", `@param defaultValue`, `@param fieldTypeName` | `getDefaultValue(Object,
String, boolean)`, two declarations below; it sat on `evaluatedType(Class)`,
which has neither parameter |
| `JavaChainParser` | "The token ranges of the bodies of `configure()` …
collecting the constants of the class on the way" |
`findMethodBodies(Map<String, Node> constants)`; it sat on the
`BUILDER_ENTRIES` constant |
| `SimpleTokenizer` | "Create the next token" with `@param filter` |
`nextToken(String, int, boolean, TokenType...)`, which was undocumented; it sat
on `setNotOperator(boolean)` |
| `GoogleSheetsJsonStructDataTypeTransformer` | "Converts message body to
list of Json objects. Supports … List, String, InputStream" |
`bodyAsJsonBeans(Message)`, which was undocumented; it sat on
`valueRangeOf(Object)`, which takes a parsed `JsonObject` and no message |
| `ChaosRule` | "Whether the message meets the condition of `when=`" |
`matchesWhen(Exchange)`, which was undocumented; it sat on `keyOf(Exchange)` |
| `ChaosRule` | "The effect of the faults of a rule on the exchanges it
faulted…" | the nested `Effect` class, which was undocumented; it sat on
`InRoute` |
Two cases are not a move:
- `EasyPredicateOperators.hasOperator` kept an earlier one-line description
above the fuller one that replaced it. The first block was already dead
text; dropped.
- `CassandraSessionHolder` had a "Keyspace name" block documenting a field
that is commented out as unused, which left it attached to
`managedSession`'s own block. The dead declaration and its description are
removed together.
### Scope and verification
Comment-only, except for the one commented-out declaration removed in
`CassandraSessionHolder`; no behaviour changes and nothing a test can
observe. Every target was confirmed to be the only member in its file with a
matching signature and to have no Javadoc of its own, so nothing is
overwritten.
Four further hits in `camel-docker`'s `DockerProducer` are the
`/***** Section *****/` banners used to separate groups of methods there, and
are left alone. The remaining hits are all in `camel-jbang`, which is under
active development; those are kept out of this PR to avoid conflicting with
work in flight.
--
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]
