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.

Sign up for GitHub

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

Jump to bottom

Fix source link to the line with name #2724

Merged
merged 4 commits into from Oct 26, 2022
Merged

Fix source link to the line with name #2724

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
725ea9d
Fix source link to the line with name
vmishenev Oct 19, 2022
9294087
Skip javadoc
vmishenev Oct 20, 2022
bf90248
Lead to identifier
vmishenev Oct 21, 2022
8b25ee2
Add test
vmishenev Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion plugins/base/src/main/kotlin/transformers/pages/sourcelinks/SourceLinksTransformer.kt
View file
Open in desktop
Expand Up @@ -2,6 +2,8 @@ package org.jetbrains.dokka.base.transformers.pages.sourcelinks

import com.intellij.psi.PsiDocumentManager
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiWhiteSpace
import com.intellij.psi.javadoc.PsiDocComment
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
import org.jetbrains.dokka.analysis.DescriptorDocumentableSource
Expand All @@ -16,6 +18,7 @@ import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.dokka.transformers.pages.PageTransformer
import org.jetbrains.kotlin.descriptors.DeclarationDescriptorWithSource
import org.jetbrains.kotlin.kdoc.psi.api.KDoc
import org.jetbrains.kotlin.resolve.source.getPsi
import org.jetbrains.kotlin.utils.addToStdlib.cast
import java.io.File
Expand Down Expand Up @@ -92,8 +95,10 @@ class SourceLinksTransformer(val context: DokkaContext) : PageTransformer {
}

private fun PsiElement.lineNumber(): Int? {
val skippedDoc = children.firstOrNull { it !is KDoc && it !is PsiDocComment }
?.let { if (it is PsiWhiteSpace) it.nextSibling else it } ?: this
// synthetic and some light methods might return null
val textRange = textRange ?: return null
val textRange = skippedDoc.textRange ?: return null

val doc = PsiDocumentManager.getInstance(project).getDocument(containingFile)
// IJ uses 0-based line-numbers; external source browsers use 1-based
Expand Down
5 changes: 4 additions & 1 deletion plugins/base/src/test/kotlin/enums/JavaEnumsTest.kt
View file
Open in desktop
Expand Up @@ -47,6 +47,9 @@ class JavaEnumsTest : BaseAbstractTest() {
|/src/main/java/basic/JavaEnum.java
|package testpackage
|
|/**
|* doc
|*/
|public enum JavaEnum {
| ONE, TWO, THREE
|}
Expand All @@ -62,7 +65,7 @@ class JavaEnumsTest : BaseAbstractTest() {


assertEquals(
"https://github.com/user/repo/tree/master/src/main/java/basic/JavaEnum.java#L3",
"https://github.com/user/repo/tree/master/src/main/java/basic/JavaEnum.java#L6",
sourceLink
)
}
Expand Down
5 changes: 4 additions & 1 deletion plugins/base/src/test/kotlin/enums/KotlinEnumsTest.kt
View file
Open in desktop
Expand Up @@ -398,6 +398,9 @@ class KotlinEnumsTest : BaseAbstractTest() {
|/src/main/kotlin/basic/KotlinEnum.kt
|package testpackage
|
|/**
|* Doc
|*/
|enum class KotlinEnum {
| ONE, TWO, THREE
|}
Expand All @@ -412,7 +415,7 @@ class KotlinEnumsTest : BaseAbstractTest() {
.attr("href")

assertEquals(
"https://github.com/user/repo/tree/master/src/main/kotlin/basic/KotlinEnum.kt#L3",
"https://github.com/user/repo/tree/master/src/main/kotlin/basic/KotlinEnum.kt#L6",
sourceLink
)
}
Expand Down