Add documentation with the type signature and kdoc #21
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
Strum355
reviewed
Nov 19, 2021
semanticdb-kotlinc/minimized/src/generatedSnapshots/resources/kotlin/snapshots/Docstrings.kt
Outdated
Show resolved
Hide resolved
Strum355
reviewed
Nov 19, 2021
semanticdb-kotlinc/src/test/kotlin/com/sourcegraph/semanticdb_kotlinc/test/AnalyzerTest.kt
Outdated
Show resolved
Hide resolved
Strum355
approved these changes
Nov 19, 2021
olafurpg
force-pushed
the
documentation
branch
from
7495ddd to
d5c79e2
Compare
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.
Previously, the semanticdb-kotlinc compiler plugin didn't emit the symbol signature or kdoc strings. This commits adds support for this missing feature by rendering the type signature as markdown alongside the kdoc string.
In the future, we can reconsider emitting
SymbolInformation.signatureso thatlsif-java index-semanticdbcan render the symbol signature. However, this change is enough to unblock Kotlin GA™️ support.Fixes #21