Is there a convention for documenting Lambdas as a function parameter in KDoc?

Viewed 166

I'm writing a Kotlin function which takes a lambda as a parameter, like

fun someFunction( param1: (value1: Boolean, value2: Boolean) -> Unit )

I'm wondering if there's a way to document the function as input, so I can reference value1 or value2 in the documentation?

So far doing

/**
* Documentation for someFunction
* @param param1 Takes a function where [value1] is some value
*/
fun someFunction( param1: (value1: Boolean, value2: Boolean) -> Unit )

hasn't worked, dokka will simply fail to build docs.

0 Answers
Related