Sebastian Schuberth
02/20/2023, 10:32 AM[param]
syntax, IntelliJ show the references as unresolved.CLOVIS
02/20/2023, 10:39 AMSebastian Schuberth
02/20/2023, 10:40 AM* A [Closeable] class which temporarily moves away [directories] to inside a [stashDir] and moves them back on close.
* Any conflicting directory created at the location of an original directory is deleted before the original state is
* restored. If a specified directory did not exist on initialization, it will also not exist on close.
*/
private class DirectoryStash(directories: Set<File>, stashDir: File) : Closeable {
directories
and stashDir
are unresolved.CLOVIS
02/20/2023, 10:42 AMSebastian Schuberth
02/20/2023, 10:43 AMCLOVIS
02/20/2023, 10:44 AMWhat would be the correct syntax then?If the constructor parameters are properties, you can resolve them in the class documentation:
/**
* Some example: [a]
*/
class Foo(val a: Int)
If they are not properties, you can use @param
:
class Foo
/**
* The primary constructor.
*
* @param a test
*/
constructor(a: Int) {
init {
println(a)
}
}
However, I expected this to work and it didn't, which seems worth reporting as a bug:
class Foo
/**
* The primary constructor [a].
*/
constructor(a: Int) {
init {
println(a)
}
}
Sebastian Schuberth
02/20/2023, 10:53 AMCLOVIS
02/20/2023, 10:55 AM/**
* test
*
* @constructor Hello world, [a]
*/
class Foo(a: Int)
I doesn't seem to resolve a
as well, I think this one is a bug.Sebastian Schuberth
02/20/2023, 10:58 AMCLOVIS
02/20/2023, 11:16 AMVadim Mishenev
02/21/2023, 8:55 PMI doesn't seem to resolveUnfortunately, we do not support inlined docs inside theas well, I think this one is a bug.a
@constructor
tag. See https://github.com/Kotlin/dokka/issues/1953CLOVIS
02/21/2023, 9:09 PM