I am having some trouble with dokka. If I do not specify a return type explicitly (I am using the syntax: fun foo() = bar()) then dokka uses NonExistentClass instead. I do not want to type return types only because dokka is not good enough. any suggestions?

@robstoll I'm not entirely sure how to do that, I imported it but the import is greyed out and squiggly-lined saying "unused import"... and the

[Long.myExtensionFunction]

is still underlined (the stuff after the

.

) - update: now it's removed the import

Is there a way to include a code sample that defines some new sealed classes in a kdoc? I’m aware of

@snippet

but that requires that the code be in a function, and I can’t declare sealed classes inside a function. I’ve also tried using the triple-backticks to embed the code directly, but for some reason that doesn’t seem to retain indenting (at least in the Intellij preview of the kdoc)

I am including some sample code for a package using an “includes” markdown file. The sample code is fenced by three backticks. The default documentation generates as expected. However, the generated javadoc has the code all on one line. Is backticks the proper way to apply the code fence in an includes document?

@semoro Thanks. That means if I want to upgrade android gradle build tool, I have to check whether the current version of dokka is supported?

@semoro I'm getting a FileNotFoundException "https://kotlinlang.org/api/latest/jvm/stdlib/package-list" on master (using 1.1.3-eap-34) - is this known/expected?

Caused by: java.io.FileNotFoundException: <https://kotlinlang.org/api/latest/jvm/stdlib/package-list>
	at sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1872)
	at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1474)
	at sun.net.www.protocol.https.HttpsURLConnectionImpl.getInputStream(HttpsURLConnectionImpl.java:254)
	at java.net.URL.openStream(URL.java:1045)
	at org.jetbrains.dokka.ExternalDocumentationLinkResolver.loadPackageLists(ExternalDocumentationLinkResolver.kt:30)
	at org.jetbrains.dokka.ExternalDocumentationLinkResolver.<init>(ExternalDocumentationLinkResolver.kt:60)
	at org.jetbrains.dokka.ExternalDocumentationLinkResolver$$FastClassByGuice$$34356095.newInstance(<generated>)

I’ve brew installed kotlin, but can’t find a package for dokka

I can’t even get help out of it

So this problem might be a bit of a corner case, but I’m wondering if it is supported by Dokka: I have created a Kotlin specific library with a bunch of extension methods for a normal Android library. The base library is included as a

provided

dependency. Now I want to generate KDoc files for only my extension methods, but It doesn’t look possible without getting a lot of errors about missing types and the resulting Doc looks like this

fun <E> <ERROR CLASS>.where(clazz: KClass<E>): <ERROR CLASS><E>

. Is there a way to generate the KDoc for only my extension method and still show the class names?

yeah I debated putting them in the org.slf4j package (since you're going to import that anyway if you're going to use them)

Any chance of getting dokka into sdkman, so it’s installed when I do

sdkman install kotlin

?

https://github.com/Kotlin/dokka/issues/167 - Any body else facing this issue with

0.9.14

?

Anyone ever seen an error like

Error:Could not get unknown property 'org' for project ':library' of type org.gradle.api.Project.

when using dokka? Trying to do

task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
            outputFormat = 'javadoc'
            outputDirectory = "$buildDir/javadoc"
        }

        task androidDokkaJar(type: Jar, dependsOn: dokkaJavadoc) {
            classifier = 'javadoc'
            from dokkaJavadoc.outputDirectory
        }

Dokka 0.9.15 released! https://github.com/Kotlin/dokka/releases/tag/0.9.15 * Bundled Kotlin compiler updated to 1.1.3 * (Gradle) processConfigurations now deprecated, new configuration mechanism kotlinTasks added. * (#168) Compatibility with Android Build Tools 3.0.0-alpha3+ * When Gradle plugin dokka-android used Android Reference now linked by default. * (#171) Fixed parameters formatting is broken in 0.9.14 * (#167, KT-18213) Fixed StringIndexOutOfRange for Markdown reference style links. * Added opt-in caching of package-list's, see cacheRoot in the docs.

Any idea when it will be released ? (I would like to use that in Spring Framework documentation)

Any reason why

classpath

is not an

Iterable<File>

like

sourceDirs

? It seems to prevent using easily

FileCollection

...

Looks like if I have

dokka-gradle-plugin:0.9.15

and

kotlin-gradle-plugin:1.1.50

my build blows up with

Using Kotlin incremental compilation
e: java.lang.NoSuchMethodError: kotlin.reflect.jvm.internal.KClassImpl.getData()Lkotlin/reflect/jvm/internal/ReflectProperties$LazyVal;
        at kotlin.reflect.full.KClasses.getMemberProperties(KClasses.kt:149)
        at org.jetbrains.kotlin.compilerRunner.ArgumentUtils.convertArgumentsToStringList(ArgumentUtils.java:59)
        at org.jetbrains.kotlin.compilerRunner.ArgumentUtils.convertArgumentsToStringList(ArgumentUtils.java:47)
        at org.jetbrains.kotlin.compilerRunner.GradleCompilerRunner.compileWithDaemonOrFallback(GradleKotlinCompilerRunner.kt:147)
        at org.jetbrains.kotlin.compilerRunner.GradleCompilerRunner.compileWithDaemonOrFallback(GradleKotlinCompilerRunner.kt:52)
        at org.jetbrains.kotlin.compilerRunner.KotlinCompilerRunner.runCompiler(KotlinCompilerRunner.kt:127)
        at org.jetbrains.kotlin.compilerRunner.GradleCompilerRunner.runJvmCompiler(GradleKotlinCompilerRunner.kt:107)
        at org.jetbrains.kotlin.gradle.tasks.KotlinCompile.callCompiler$kotlin_gradle_plugin(Tasks.kt:326)
        at org.jetbrains.kotlin.gradle.tasks.KotlinCompile.callCompiler$kotlin_gradle_plugin(Tasks.kt:231)
        at org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompile.execute(Tasks.kt:203)
        …

Getting an NPE when running the dokka Gradle task (using Gradle 4.1): https://kotlinlang.slack.com/files/U5R5FGVH7/F776ZPUE4/npe_with_dokka_task.txt

Is this for Gradle DSL or Gradle Kotlin DSL?

That could be also an opportunity to make Dokka suitable by default for kotlin2js and Gradle Kotlin DSL.

@semoro I'm willing to take a crack at this one: https://github.com/Kotlin/dokka/issues/197, but could use a little guidance as to how you might want is structured.

Has anyone ran into issues with

@property

when writing KDoc? Using the Kotlin plugin for Android Studio it appears to break the generation of documentation for the tooltip window. Essentially everything after

@property

does not display.

is it feasible to support showing java signatures for java classes in dokka (with

outputFormat = 'html'

)? I’d love to use a single doc generator with single look & feel for my project’s java and kotlin apis. however, I need the java docs to show java signatures. (the reason for writing some of my apis in java is that I can’t impose kotlin on everyone.)

Not sure if this is an error in the generated documentation or the generated bytecode (but I can hardly believe that protected methods compile down to public ones, so I would guess it's an error with Dokka?)

i’m using dokka to generate javadoc - i’m seeing methods like

componentN()

that have the documentation of each @property definition of my class applied to them (on top of the generated

getProperty()

methods). is this expected?

/**
 * Represents an error that will be serialized back to the client in a standardized format.
 * This should be used for all error responses that require a body to be returned in the response.
 *
 * @property description User-facing description of the error
 * @property type Type of the error
 * @property code An optional unique identifier for the particular error
 * @constructor Create an Error instance
 */
data class Error(val description: String, val type: ErrorType, val code: String? = null)

Any idea when the next Dokka release will be?

@Ian sounds similar to https://github.com/Kotlin/dokka/issues/146

Well, I think I've hit a dead end. I defined my own

FormatDescriptor

for a style that does everything the html format does excpet using

KotlinWebsiteSampleProcessingService

. That seems straight forward - define dokka/format/myformatname.properties and away we go. But I think the way the gradle-dokka plugin is looking up resources, I'm never going to be able to package my`FormatDescriptor` and its property files in a separate jar. I tried doing this and the packaging looks correct, and the jar for my formatter is on the build's classpath (so, in the buildscript/dependencies section), but I keep getting exceptions that it can't be found. https://github.com/Kotlin/dokka/blob/d1eee305ef865eee8848989363db3f0fed63e11a/core/src/main/kotlin/Utilities/ServiceLocator.kt#L33

This message was deleted.