Dhairya-007 opened a new pull request, #29650:
URL: https://github.com/apache/camel/pull/29650
The `camel-jbang` half of #29641. Two `/** */` blocks in a row leave the
earlier one out of the generated documentation entirely — Javadoc keeps only
the last block before a declaration — and attribute its text to the wrong
member when reading the source.
Six blocks are moved to the member they describe, each of which had no
Javadoc of its own:
| File | Block | Belongs to |
|---|---|---|
| `AboutView` | "The routes in the order of the Routes panel…" |
`routeOrder(IntegrationInfo)`; it sat on `stripName` |
| `AutocompletePopup` | "The title of the list with its count…" | `title()`;
it sat on `isAdvanced` |
| `McpFacade` | "As `editFile(String, String, String, String, boolean)` with
several edits…" | the `editFile` overload it points at; it sat on
`APPLIED_WRITES` |
| `AuthoringTools` | "Replaces one snippet of a file and writes the result
through `writeFile`…" | `editFile(ToolContext, Path, String, String, String)`;
it sat on `EDIT_WINDOW_LINES` |
| `SimpleChecks` | "A function served by a language or a component that is
not on the classpath…" | `isMissingDependency(String)`; it sat on
`isOfTheApplication`, which has its own block about application classes |
| `IntegrationSummary` | "Strips Markdown emphasis, code ticks and quotes
around a value." | `clean(String)`, which strips exactly that |
Two are not a move:
- `ChaosRecipes.Recipe` kept a one-line "A known rule." above the fuller
description that replaced it. Javadoc already ignored it; dropped.
- `TabRegistry.MoreTab` had its description and its `@param` tags in two
separate blocks, so only the tags survived and the explanation of what a
`MoreTab` is was lost. Both describe the same record, so they are merged
into one block.
### Left for someone who knows the code
`AiUsageStats` has a stranded "One model round trip. `question` is the
sequence number…", which describes the `AiUsageEntry` record — that record is
not in this file, so there is nowhere here to reattach it to. The remaining
hits in `CatalogDocs`, `BeanRefChecks`, `TuiToolDefinitions`,
`DiagramSupport`
and `YamlValidator` are the same shape but I could not prove which member
each
belongs to, so I left them rather than guess. I'm happy to follow up if you
tell me where they were meant to go.
Comment-only; no behaviour changes.
--
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]
