Skip to content

Conversation

@ebarboni
Copy link
Contributor

@ebarboni ebarboni commented Apr 4, 2025

this is a first step to reduce to 300 linkage error. (was around 900)

Basically our previous link class.html#method-type- should be rewritten with class.html#method(type)

constructor link use # and need to be xml compatible using the following #%3Cinit%3E
same applied to array []

doc-files content is parsed by javadoc, so {@link } and others tag can be used. Make the javadoc a bit more semanticaly linked.
I started using @link when in text. I keep the old reference system when it's a code block. Could be nice to later have snippet instead the fuzzy html.

On infra side, h5 need to be checked for anchor reference

@ebarboni ebarboni added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Apr 4, 2025
@ebarboni ebarboni added this to the NB26 milestone Apr 4, 2025
@ebarboni ebarboni requested a review from mbien April 4, 2025 17:34
Copy link
Member

@mbien mbien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@ebarboni ebarboni merged commit 2e59597 into apache:master Apr 5, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

JavaDoc [ci] enable java/javadoc tests and build-javadoc target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants