Skip to content

Commit 9dcd8f3

Browse files
committed
Fix review comment
1 parent e213bd5 commit 9dcd8f3

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/translators/AnnotationTranslator.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ internal class AnnotationTranslator(private val logger: DokkaLogger) {
8484
val psi = annotation.psi
8585
val location = psi?.let { getLocation(it) }
8686
val text = psi?.text.orEmpty()
87-
logger.warn("Unknown annotation $text in $location")
87+
logger.warn("Unknown annotation `$text` in $location")
8888
logger.debug(
89-
"Unknown annotation $text in ${location}\n" + Thread.currentThread().stackTrace.drop(1)
89+
"Unknown annotation `$text` in ${location}\n" + Thread.currentThread().stackTrace.drop(1)
9090
.joinToString("\n")
9191
)
9292
DRI(packageName = "", classNames = ERROR_CLASS_NAME)
@@ -140,7 +140,7 @@ internal class AnnotationTranslator(private val logger: DokkaLogger) {
140140
else -> {
141141
val psi = annotationValue.sourcePsi ?: containingAnnotation.psi
142142
val location = psi?.let { getLocation(it) }
143-
logger.warn("Unknown annotation value ${psi?.text.orEmpty()} in $location")
143+
logger.warn("Unknown annotation value `${psi?.text.orEmpty()}` in $location")
144144

145145
ClassValue(
146146
type.toString(),
@@ -151,7 +151,7 @@ internal class AnnotationTranslator(private val logger: DokkaLogger) {
151151
is KaAnnotationValue.UnsupportedValue -> {
152152
val psi = annotationValue.sourcePsi ?: containingAnnotation.psi
153153
val location = psi?.let { getLocation(it) }
154-
logger.warn("Unsupported annotation value ${psi?.text.orEmpty()} in $location")
154+
logger.warn("Unsupported annotation value `${psi?.text.orEmpty()}` in $location")
155155

156156
ClassValue(
157157
"<Unsupported Annotation Value>",

dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/translators/TypeTranslator.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ internal class TypeTranslator(
123123
)
124124
)
125125
is KaErrorType -> {
126-
report(type, location)
126+
logErrorType(type, location)
127127
@OptIn(KaNonPublicApi::class)
128128
UnresolvedBound(type.presentableText ?: type.toString())
129129
}
@@ -181,7 +181,7 @@ internal class TypeTranslator(
181181
is KaTypeAliasSymbol -> toTypeConstructorWithKindFrom(classSymbol.expandedType, location)
182182
}
183183
is KaErrorType -> {
184-
report(type, location)
184+
logErrorType(type, location)
185185
@OptIn(KaNonPublicApi::class)
186186
TypeConstructorWithKind(
187187
GenericTypeConstructor(
@@ -221,10 +221,10 @@ internal class TypeTranslator(
221221
KaClassKind.ANONYMOUS_OBJECT -> KotlinClassKindTypes.OBJECT
222222
}
223223

224-
private fun KaSession.report(errorType: KaErrorType, location: Location) {
224+
private fun KaSession.logErrorType(errorType: KaErrorType, location: Location) {
225225
@OptIn(KaNonPublicApi::class)
226226
logger.warn(buildString {
227-
append(if (errorType.presentableText != null) "${errorType.presentableText} is unresolved" else errorType.errorMessage)
227+
append(if (errorType.presentableText != null) "`${errorType.presentableText}` is unresolved" else errorType.errorMessage)
228228
append(" in ")
229229
append(
230230
with(location) {

dokka-subprojects/plugin-base/src/test/kotlin/translators/SymbolsTranslatorTest.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class SymbolsTranslatorTest : BaseAbstractTest() {
2020

2121
@Test
2222
@OnlySymbols
23-
fun `method overriding two documented classes picks closest class documentation`() {
23+
fun `should warn about unresolved symbol`() {
2424
testInline(
2525
"""
2626
|/src/main/kotlin/Test.kt
@@ -34,7 +34,7 @@ class SymbolsTranslatorTest : BaseAbstractTest() {
3434
.replace("\\","/") // for Win
3535

3636
assertEquals(
37-
"UnresolvedSymbols is unresolved in file:///PATH/Test.kt:1:7",
37+
"`UnresolvedSymbol` is unresolved in file:///PATH/Test.kt:1:7",
3838
warn.replace(path, "PATH")
3939
)
4040
assertEquals(
@@ -65,11 +65,11 @@ class SymbolsTranslatorTest : BaseAbstractTest() {
6565
.replace("\\","/") // for Win
6666

6767
assertEquals(
68-
"Unknown annotation @Unresolved(1) in file:///PATH/Test.kt:1:10",
68+
"Unknown annotation `@Unresolved(1)` in file:///PATH/Test.kt:1:10",
6969
warns[0].replace(path, "PATH")
7070
)
7171
assertEquals(
72-
"Unsupported annotation value @Deprecated(asda) in file:///PATH/Test.kt:3:1",
72+
"Unsupported annotation value `@Deprecated(asda)` in file:///PATH/Test.kt:3:1",
7373
warns[1].replace(path, "PATH")
7474
)
7575
assertEquals(

0 commit comments

Comments
 (0)