Skip to content
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

Add support for linking to packages from KDoc and Javadoc #3371

Closed
wants to merge 2 commits into from

Conversation

nea89o
Copy link
Contributor

@nea89o nea89o commented Nov 23, 2023

Closes #3004

Copy link
Contributor

@vmishenev vmishenev left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution.

Can you add some unit tests for this issue (Javadoc and KDoc links)?
For example,

//JavaTest.kt
    @Test
    fun `should have a link to a package in see doctag`() {
        inlineModelTest(
            """
            |/**
            | * @see java
            | */
            |public class Foo {
            |}
            """, configuration = configuration
        ) {
            with((this / "java" / "Foo").cast<DClass>()) {
                val doc = this.documentation.values.single()
                val expectedDRI = DRI(
                    packageName = "java", classNames = null,
                    target = PointingToDeclaration,
                )
                assertEquals(expectedDRI, (doc.dfs { it is See } as See).address)
            }
        }
    }

@vmishenev
Copy link
Contributor

Thank you again for your contribution.
I will pick up these commits to add unit tests. You will be included as an author of this.
So I have closed it in favour of #3490.

@vmishenev vmishenev closed this Mar 20, 2024
@nea89o
Copy link
Contributor Author

nea89o commented Mar 21, 2024

And thank you for finishing it! I have completely lost this out of my sight.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Linking to a package in Javadoc using @see renders weirdly
3 participants