gnodet commented on PR #2060:
URL: https://github.com/apache/maven-resolver/pull/2060#issuecomment-5470600072
## Review findings
I did a thorough review of this PR, built the website, and inspected the
generated configuration page. Here's what I found:
### Generated configuration page ✅
The configuration page generates correctly with:
- Internal `apidocs/` links for resolver types
(ConfigurationProperties.HttpVersion, RepositorySystemSession, DependencyNode,
etc.)
- External `docs.oracle.com` links for JDK types (160 links)
- Stable anchors for all configuration keys
- Cross-reference links between configuration keys
- All 9 tests pass
### Issues found and fixed in #2078
1. **`visitLink` renders reference instead of label** — The `visitLink`
method renders `node.getReference()` (the link target) instead of
`node.getLabel()` (the explicit label text). For `{@link Type custom label}`,
it shows "Type" instead of "custom label". While current configuration sources
don't use explicit labels, this is a correctness bug.
2. **Markdown emphasis around HTML content** — The `configuration.md.vm`
template wraps HTML deprecated content in Markdown emphasis markers (`*...*`),
mixing Markdown and HTML. Fixed by using `<em>` instead.
3. **Missing trailing newline** in `package-info.java` test fixture.
### Architecture assessment ✅
- The `isInternalJavadocElement` logic correctly handles nested types,
visibility filtering, and source-tree-based resolution
- The `JavadocLinkGenerator` integration is well done — version-aware link
formatting (JDK 8 hyphen style vs JDK 10+ parenthesis style)
- Error reporting with `DocTreePathAwareRuntimeException` provides precise
source-location-aware diagnostics
- Cross-module detection via `--internal-javadoc-source-tree` is clean and
avoids coupling to the Maven reactor
- Test coverage is solid across internal/external links, cross-module
resolution, module elements, and error cases
_This review was generated by an AI agent and may contain inaccuracies.
Please verify all suggestions before applying._
--
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]
