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

Any plan to support inline tag {@link} and block tag {@link} for kotlin comment? #3599

Open
david-Lin0909 opened this issue May 6, 2024 · 2 comments
Labels
enhancement An issue for a feature or an overall improvement language: Java Issue/PR related to the Java language feature/analysis/docs

Comments

@david-Lin0909
Copy link

Is your feature request related to a problem? Please describe
when using dokka to generate JAVA Doc for java src files, The inline tag {@link} and block tag {@link} works well on generated html format document.
(see: https://www.baeldung.com/javadoc-see-vs-link for refer inline & block @link tag)

But i found, both of them are not supported well when generated document for kotlin src files. they are displayed as raw string.
reading kotlin doc file, it says online block tag @see is supported in dokka.

Describe the solution you'd like
hoping both kinds of @link can be supported in kotlin source code as well.

Describe alternatives you've considered
Be able to use @see instead of block tag @link, but no way for inline tag.

Additional context
Add any other context or screenshots about the feature request here

@david-Lin0909 david-Lin0909 added the enhancement An issue for a feature or an overall improvement label May 6, 2024
@vmishenev vmishenev added the language: Java Issue/PR related to the Java language feature/analysis/docs label May 10, 2024
@vmishenev
Copy link
Member

Why do you not use the existing markup syntax? What is your use case?

@david-Lin0909
Copy link
Author

@vmishenev , Thanks a lot for your replying.
because, the markup syntax not always works well with below html configuration? (Seems I need to add some other configuration to support markup syntax? or i need to choose markup format output if i use any markup syntax? Thanks)

outputDir": "./dokka/html",
"moduleName": "Dokka Example",
"sourceSets": [
{
"displayName": "jvm",
"sourceSetID": {
"scopeId": "moduleName",
"sourceSetName": "main"
},
"skipEmptyPackages": true,
"jdkVersion": 8,
"noStdlibLink": true,
"noJdkLink": true,
"sourceRoots": [
"/Users/myName/projects/kotlin/com/myCompany/kotlin"
]
}
],
"pluginsClasspath": [
"./dokka-base-1.9.20.jar",
"./kotlinx-html-jvm-0.8.0.jar",
"./analysis-kotlin-descriptors-1.9.20.jar",
"./freemarker-2.3.31.jar"
],
"perPackageOptions": [
{
"matchingRegex": "myCompany.atom",
"suppress": true,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
},
{
"matchingRegex": "myCompany.file",
"suppress": true,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
},
{
"matchingRegex": "myCompany.json",
"suppress": true,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
},
{
"matchingRegex": "myCompany.xml",
"suppress": true,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
},
{
"matchingRegex": "myCompany.core",
"suppress": true,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
}
]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement language: Java Issue/PR related to the Java language feature/analysis/docs
Projects
None yet
Development

No branches or pull requests

2 participants