Repository navigation
docs: fix rendering of element names in repositoryOrigins/settings descriptions - #13680
Closed
suryakant-source wants to merge 1 commit into
Closed
suryakant-source wants to merge 1 commit into
suryakant-source wants to merge 1 commit into
Conversation
gnodet-bot
approved these changes
Oct 22, 2026
gnodet-bot
left a comment
There was a problem hiding this comment.
LGTM. The root cause is well-identified (modello-plugin-xdoc's rewrite() strips HTML elements nested inside <code> generated from {@code <X>}), and the fix is minimal and correctly targeted — switching only the five occurrences where the {@code} content contains HTML-encoded angle brackets. Leaving {@code -P} and {@code scheme://host} unchanged is correct since those render fine.
Note for maintainers: api/maven-api-model/src/main/mdo/maven.mdo has 228 occurrences of {@code and the same {@code <element>} pattern is present there too (not in scope here but worth a follow-up).
This review was generated by an AI agent, Hermès on behalf of @gnodet.
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #13675.
Problem
On https://maven.apache.org/ref/3.10.0/maven-settings/settings.html, several descriptions render with an empty inline code element, e.g. "not listed in
<code></code>but activated through<code></code>or<code>-P</code>", so the element names (<server>,<activeProfile>, ...) are swallowed.Root cause
In
api/maven-api-settings/src/main/mdo/settings.mdo, the affected descriptions write the element names as{@code <X>}. After the .mdo XML decoding, modello-plugin-xdoc'srewrite()(javadoc-parser + jsoup) receives{@code <X>}and generates<code><X></X></code>: the unknown element inside<code>is dropped downstream, leaving an empty code element. The raw-markup form<code><X></code>, already used elsewhere in the same file, survives the pipeline and renders correctly.I reproduced this locally with the exact
rewrite()code path of modello-plugin-xdoc using modello's pinned versions (javadoc-parser 0.3.1, jsoup 1.23.2): the{@code <X>}form produces the nested/broken markup while<code><X></code>produces the correct output.Solution
Switch the affected descriptions in
settings.mdo(proxy, server, activeProfiles, activation, property.name) from{@code <X>}to<code><X></code>. This form renders correctly in both the generated site page and the generated javadoc.Testing
rewrite()code path (javadoc-parser 0.3.1 + jsoup 1.23.2): verified broken output before and correct output after for each of the 5 changed spots.settings.mdois still well-formed XML.Risk
Low: docs-source-only change. Note: the same
{@code <...>}pattern exists in other .mdo files (e.g.maven.mdo); I left those untouched here and can follow up if the maintainers want them fixed the same way.