Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support rich documentation of property parameters. #3689

Open
owengray-google opened this issue Jul 10, 2024 · 0 comments
Open

Support rich documentation of property parameters. #3689

owengray-google opened this issue Jul 10, 2024 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement

Comments

@owengray-google
Copy link
Contributor

/**
 * @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.

@owengray-google owengray-google added the enhancement An issue for a feature or an overall improvement label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

1 participant