Skip to content

Links are broken in KDocs #30091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hantsy opened this issue Mar 9, 2023 · 4 comments
Closed

Links are broken in KDocs #30091

hantsy opened this issue Mar 9, 2023 · 4 comments
Assignees
Labels
status: duplicate A duplicate of another issue theme: kotlin An issue related to Kotlin support type: documentation A documentation task

Comments

@hantsy
Copy link
Contributor

hantsy commented Mar 9, 2023

Currently I am working on a Spring WebFlux/Kotlin Coroutines project, and explored the Spring Kotlin extensions docs frequently, but the links in these docs are still broken in 6.0.6.

For example:

https://docs.spring.io/spring-framework/docs/6.0.6/kdoc-api/spring-tx/org.springframework.transaction.reactive/transactional.html

The TransacationalOperator.transactional is redirected to:

https://docs.spring.io/spring-framework/docs/6.0.6/kdoc-api/spring-tx/org.springframework.transaction.reactive/-transactional-operator/transactional.html

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Mar 9, 2023
@sdeleuze sdeleuze self-assigned this Mar 9, 2023
@sdeleuze sdeleuze added theme: kotlin An issue related to Kotlin support type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Mar 9, 2023
@sdeleuze sdeleuze added this to the 6.0.7 milestone Mar 9, 2023
@sdeleuze
Copy link
Contributor

sdeleuze commented Mar 9, 2023

I think this is potentially because we don't generate the Kdoc for Java code, on purpose to not loose the Kotlin specific APIs in the Java ones but as a result links are broken. A way to fix this would be to set regular links to Spring Java API.

@sdeleuze sdeleuze modified the milestones: 6.0.7, 6.1.x Mar 9, 2023
@sdeleuze sdeleuze added the status: blocked An issue that's blocked on an external project change label Mar 9, 2023
@sdeleuze
Copy link
Contributor

sdeleuze commented Mar 9, 2023

After a deeper look, I tend to think that Dokka should support this use case, I have created Kotlin/dokka#2913 related issue.

@sdeleuze
Copy link
Contributor

sdeleuze commented Dec 7, 2023

Kotlin/dokka#2272 is the new blocking issue for this.

@jhoeller jhoeller modified the milestones: 6.1.x, 6.x Backlog Jan 11, 2024
@sdeleuze
Copy link
Contributor

Fixed via #32797.

@sdeleuze sdeleuze closed this as not planned Won't fix, can't repro, duplicate, stale May 16, 2024
@sdeleuze sdeleuze removed this from the 6.x Backlog milestone May 16, 2024
@sdeleuze sdeleuze added status: duplicate A duplicate of another issue and removed status: blocked An issue that's blocked on an external project change labels May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: duplicate A duplicate of another issue theme: kotlin An issue related to Kotlin support type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

4 participants