[Javadoc] Ignore Kotlin samples #3473
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
vmishenev
force-pushed
the
vmishenev/3466-javadoc-fix-error-message-for-kotlin-samples
branch
from
569c393
to
1860928
Compare
vmishenev
commented
Jan 25, 2024
dokka-subprojects/plugin-javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt
Outdated
Show resolved
Hide resolved
This is a laconic solution to avoid an error message (#3466) for Kotlin samples in unstable Javadoc format. There are 2 problems. 1. Javadoc's content model does not contain samples links at all. It should contain something like `samplesSectionContent` in the base plugin. 2. Sample Transformer from the base plugin knows nothing about Javadoc's content model. see `DefaultSamplesTransformer.dfs`, e.g. `JavadocContentGroup` is unavailable from the base plugin.
vmishenev
force-pushed
the
vmishenev/3466-javadoc-fix-error-message-for-kotlin-samples
branch
from
1860928
to
547d92c
Compare
IgnatBeresnev
approved these changes
Jan 29, 2024
vmishenev
deleted the
vmishenev/3466-javadoc-fix-error-message-for-kotlin-samples
branch
IgnatBeresnev
pushed a commit
that referenced
this pull request
Jan 31, 2024
* [Javadoc] Ignore Kotlin samples This is a laconic solution to avoid an error message (#3466) for Kotlin samples in unstable Javadoc format. There are 2 problems. 1. Javadoc's content model does not contain samples links at all. It should contain something like `samplesSectionContent` in the base plugin. 2. Sample Transformer from the base plugin knows nothing about Javadoc's content model. see `DefaultSamplesTransformer.dfs`, e.g. `JavadocContentGroup` is unavailable from the base plugin. (cherry picked from commit e502b2c)
vmishenev
added a commit
that referenced
this pull request
Mar 20, 2024
* [Javadoc] Ignore Kotlin samples This is a laconic solution to avoid an error message (#3466) for Kotlin samples in unstable Javadoc format. There are 2 problems. 1. Javadoc's content model does not contain samples links at all. It should contain something like `samplesSectionContent` in the base plugin. 2. Sample Transformer from the base plugin knows nothing about Javadoc's content model. see `DefaultSamplesTransformer.dfs`, e.g. `JavadocContentGroup` is unavailable from the base plugin.
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.
This is a laconic solution to avoid an error message (#3466) for Kotlin samples in unstable Javadoc format. There are 2 problems.
samplesSectionContentin the base plugin.DefaultSamplesTransformer.dfs, e.g.JavadocContentGroupis unavailable from the base plugin.