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.

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

Sample body is not embeded to documentation #2199

Closed
atyrin opened this issue Oct 21, 2021 · 1 comment · Fixed by #2216
Closed

Sample body is not embeded to documentation #2199

atyrin opened this issue Oct 21, 2021 · 1 comment · Fixed by #2216
Labels

Comments

@atyrin
Copy link
Contributor

atyrin commented Oct 21, 2021

I have a code block

package org.jetbrains.qa

/**
 * Hello, Sample
 * @sample org.jetbrains.qa.runSample
 */
fun withSample(a: Int): Int{
    return a + 1
}

fun runSample(){
    withSample(41)
}

Regarding KDoc descriptions: https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier Iexpect that the body of runSample will be embedded to output, but as result I have just plane text function name
image

During the documentation generation process I see:

Transforming pages
Cannot find descriptor for package org
Cannot find PsiElement corresponding to org.jetbrains.qa.runSample
Rendering
Running post-actions

Installation

  • Dokka version: 1.5.31, 1.6.0-RC-dev-126
@atyrin atyrin added the bug label Oct 21, 2021
@atyrin atyrin changed the title Sample body is not emeded to documentation Sample body is not embeded to documentation Oct 22, 2021
@vmishenev vmishenev linked a pull request Nov 1, 2021 that will close this issue
@MairwunNx
Copy link

@atyrin the same problem.

Cannot find descriptor for package com
Cannot find PsiElement corresponding to com.mairwunnx.annotations.ValueXXXUnitSample

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants