Stabilize Sample analysis API #3195
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IgnatBeresnev
commented
Oct 5, 2023
...org/jetbrains/dokka/analysis/kotlin/descriptors/compiler/CompilerDescriptorAnalysisPlugin.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
commented
Oct 5, 2023
...rains/dokka/analysis/kotlin/descriptors/compiler/impl/DescriptorSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
commented
Oct 5, 2023
...tlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/SymbolSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
commented
Oct 5, 2023
...tlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/SymbolSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
force-pushed
the
stable-sample-api
branch
from
59dc29d to
bf38991
Compare
|
Squashed commits that fixed the API dump and some tests, but no major changes. |
vmishenev
reviewed
Oct 17, 2023
...lysis-kotlin-api/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/sample/SampleSnippet.kt
Outdated
Show resolved
Hide resolved
...rains/dokka/analysis/kotlin/descriptors/compiler/impl/DescriptorSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
...tlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/SymbolSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
...-api/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/sample/SampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
...tlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/SymbolSampleAnalysisEnvironment.kt
Outdated
Show resolved
Hide resolved
IgnatBeresnev
force-pushed
the
stable-sample-api
branch
from
92aa97a to
c978c5f
Compare
|
Rebased onto master, so I had to force push, but didn't squash any commits. Also addressed the review comments, so it's ready for another round |
whyoleg
reviewed
Nov 1, 2023
plugins/base/src/main/kotlin/transformers/pages/DefaultSamplesTransformer.kt
Outdated
Show resolved
Hide resolved
...lysis-kotlin-api/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/sample/SampleSnippet.kt
Outdated
Show resolved
Hide resolved
# Conflicts: # dokka-subprojects/analysis-kotlin-api/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/internal/SampleProvider.kt # dokka-subprojects/analysis-kotlin-api/src/testFixtures/kotlin/org/jetbrains/dokka/analysis/test/api/util/DokkaLoggerUtils.kt # dokka-subprojects/analysis-kotlin-api/src/testFixtures/kotlin/org/jetbrains/dokka/analysis/test/api/util/TestAnalysisApiUtils.kt # dokka-subprojects/analysis-kotlin-descriptors-compiler/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/descriptors/compiler/impl/DescriptorSampleAnalysisEnvironment.kt # dokka-subprojects/analysis-kotlin-descriptors-compiler/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/descriptors/compiler/impl/KotlinSampleProvider.kt # dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/KotlinSampleProvider.kt # dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/services/SymbolSampleAnalysisEnvironment.kt
# Conflicts: # dokka-subprojects/analysis-kotlin-api/src/testFixtures/kotlin/org/jetbrains/dokka/analysis/test/api/jvm/java/JavaConfigurationBuilder.kt # dokka-subprojects/analysis-kotlin-api/src/testFixtures/kotlin/org/jetbrains/dokka/analysis/test/api/jvm/kotlin/KotlinJvmConfigurationBuilder.kt
Should be addressed in #3359
whyoleg
approved these changes
Nov 20, 2023
vmishenev
reviewed
Nov 21, 2023
| internal fun KtAnalysisSession.resolveKDocLink(link: KDocLink): DRI? { | ||
| val lastNameSegment = link.children.filterIsInstance<KDocName>().lastOrNull() | ||
| val linkedSymbol = lastNameSegment?.mainReference?.resolveToSymbols()?.firstOrNull() | ||
| internal fun KtAnalysisSession.resolveKDocLinkDRI(link: KDocLink): DRI? { |
There was a problem hiding this comment.
I think the name resolveKDocLinkToDRI is better.
|
|
||
| if (kdocLink == null) { | ||
| dokkaLogger.warn( | ||
| "Unable to resolve a @sample link: \"$fqLink\". Is it used correctly? " + |
There was a problem hiding this comment.
I missed in the first review the message does not have the location of sample link. It can be useful to find the link in the input code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #3112, depends on #3184.
Moved the sample analysis API from internal to public, wrote documentation and a bunch of tests (obvious ones, corner cases + documentation contracts).