Jim
11/29/2021, 7:00 PM./gradlew dokkaJavadoc
following the multiplatform configuration specified here https://kotlin.github.io/dokka/1.6.0/user_guide/gradle/usage/#multiplatform but the following error:
Pre-generation validity check failed: Dokka Javadoc plugin currently does not support generating documentation for multiplatform project. Please, adjust your configurationIs this a known defect?
Anton Yalyshev [JB]
12/06/2021, 5:19 PMmikehearn
12/08/2021, 6:57 PMmikehearn
12/08/2021, 7:10 PMAmie Cilerp
12/11/2021, 4:36 PMSkolson5903
12/13/2021, 10:46 PMdokkaHtml {
moduleName.set("Anything")
dokkaSourceSets {
named("commonMain") {
noAndroidSdkLink.set(false)
}
}
dependencies {
dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.0")
}
}
and running dokkaHtml gradle task gets:
> Task :kmp-sc:dokkaHtml FAILED
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':kmp-sc:dokkaHtml'.
> org/jetbrains/dokka/model/ExtraModifiers$KotlinOnlyModifiers$Value
The github doc doesn't mention other dependencies to include explicitly, but since the only error shows a class name with no error cause, I can't tell if this is a dependency issue or not. Anyone else seen this or know what I'm doing wrong?Rescribet
01/04/2022, 10:10 PMMichael Limb
01/05/2022, 6:57 PMmodule.md
file. I know that the module documentation supports markdown, but is there any way to add a table of contents that anyone has had any success with? Seems like I've tried everything and can't get anything to work.Utkarsh Tiwari
01/11/2022, 12:31 PMcore_ds_component
of an Android project to artifactory. When I run the publish command, I get this error.
I couldn’t find dokka in the dependency graph of this module. Does anyone has any idea what could be wrong?Anton Afanasev
01/11/2022, 4:03 PMIgnat Beresnev
01/12/2022, 5:45 PM1.5.X
are missing, but 1.6.X
are available, probably stored on different nodes or something. Good time to update? 😅Jakob K
01/13/2022, 5:36 PMMichael Limb
01/13/2022, 8:50 PMmodule.md
documentation without putting the full url each time? for example:
Instead of:
Refer to the documentation for the [Resource](<http://localhost:8080/core/com.example.core/-resource/index.html>) class.
Something like:
Refer to the documentation for the [Resource] class.
Gabriele Cacchioni
01/17/2022, 9:08 AMDokka Maven plugin does not support multi-platform projects.
on the docs, does this mean it’s not yet supported? If so, is there any workaround for generating the docs for the modules and merge them together?DJ
01/23/2022, 1:47 AMbobby
01/25/2022, 6:40 AMb
c
d
in module a
, I want to exclude b
and c
so it won’t generated. Excluding certain module is working fine
2. if you see the attach image, you can find some functions. the problem is, I’m not implement any of those function explicitly in my class (in this case CameraMaskingActivity
). Moreover, I found these functions also included in other class. I don’t want this in my report, is there anyway to exclude or remove this?
3. The report folder is big, like really big, I only include 2 modules but the size already 300++mb, is there someway to reduce the size? I know it might be related to each class that bloated, but the report file size could related to my question number 2
4. (Regarding design) in the attached image, I don’t find navigation menu that on the left, for me to go to other class in the report file, at least in the same module, is there any implementation that I’m not implement?
Thank you and sorry for asking a lot of question. Cool library btw. Have a great day 😄DJ
01/25/2022, 10:06 PMJustin (Midas) Gilman
01/26/2022, 7:42 PMall-modules-page-plugin
in the Dokka repository but I can't find any documentation on how to properly configure Dokka to use thisJustin (Midas) Gilman
02/02/2022, 4:44 PM@sample
to reference some example code and I cannot get it to work. I'm looking at https://github.com/JetBrains/kotlin/blob/bd4d8479430a3ebda030ce4856886e9985cacd75/libraries/stdlib/src/kotlin/collections/Iterators.kt#L8 as an example but I can't figure out how to make it work.perry
02/04/2022, 4:19 PMjava.lang.ClassCastException: class com.intellij.psi.PsiArrayType cannot be cast to class com.intellij.psi.impl.source.PsiClassReferenceType (com.intellij.psi.PsiArrayType and com.intellij.psi.impl.source.PsiClassReferenceType are in unnamed module of loader java.net.URLClassLoader @7dcea628)
Gradle version: 7.3.3
kotin/dokka plugin version: 1.5.31 and 1.6.10 (tried upgrading, same result on both)
jdk: 11.0.13
platform: Intel MacFelix Honer
02/06/2022, 12:27 PMBradleycorn
02/07/2022, 9:06 PMtasks.dokkaGfm {
moduleName.set("app")
outputDirectory.set(projectDir.resolve("../docs"))
suppressObviousFunctions.set(true)
dokkaSourceSets {
configureEach {
displayName.set("app")
sourceLink {
// Unix based directory relative path to the root of the project (where you execute gradle respectively).
localDirectory.set(file("src/main/kotlin"))
// URL showing where the source code can be accessed through the web browser
remoteUrl.set(URL("<https://github.com/bradleycorn/resume-android/blob/master/app/src/main/kotlin>"))
// Suffix which is used to append the line number to the URL. Use #L for GitHub
remoteLineSuffix.set("#L")
}
}
}
}
Grégory Lureau
02/18/2022, 10:24 AMDJ
02/21/2022, 10:30 PM<!DOCTYPE html>
tag, which is required for browsers to use standard mode for rendering documents. Is this just a mistake or does dokka intentionally use quirks mode? If this is a bug, should I open an issue/pull request for it?uli
02/24/2022, 5:40 PMinterface MySDK {
and I have a global factory method fun MySdk()
how do I refernce the method from the interface KDoc?
The obvious approach is ambigouos and dokka chooses to resolves to the interface, not the method.
/**
* An implementation of this interface can be instantiated by calling the factory method [MySdk]()
*/
mikehearn
03/11/2022, 5:29 PM@param
tags?Grégory Lureau
03/15/2022, 11:22 AMmkrussel
03/16/2022, 10:27 PMincludeNonPublic
as deprecated in favor of documentedVisibilities
when documentedVisibilities
has not been released in the version the documentation is saying to use.thunderbiscuit
04/01/2022, 4:39 PM7.0.4
builds the latest theme of Dokka and the 7.1.2
builds the old version.Grégory Lureau
04/07/2022, 10:48 PM