You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/**
* @property bar simple documentation for bar
*/
class Foo(val bar: String) {}
If you want to have more rich documentation for bar, e.g. this request we recently saw in androidx:
/**
* A [Stub] used to set the next responses used in [FakeHealthConnectClient.aggregate].
*
* @sample androidx.health.connect.testing.samples.AggregationResult
* @see aggregateGroupByDuration
* @see aggregateGroupByPeriod
*/
There is no great way to do this in kdoc. @property does not support using other tags like @sample inside.
More broadly, this FR could be to support tags like @sample inside of tags like @property/@param. The case of @property is simply the case where this seems most clearly needed.
The text was updated successfully, but these errors were encountered:
If you want to have more rich documentation for bar, e.g. this request we recently saw in androidx:
There is no great way to do this in kdoc.
@property
does not support using other tags like@sample
inside.More broadly, this FR could be to support tags like
@sample
inside of tags like@property
/@param
. The case of@property
is simply the case where this seems most clearly needed.The text was updated successfully, but these errors were encountered: