Generated parameter documentation #99
Labels
accepted
This will be worked on
domain: Rust
Involves Rust code.
effort: 2
Relative effort required. There's no specific unit of measurement.
priority: next
I'll probably get to it, eventually.
type: feature
Brand new functionality, features, pages, workflows, endpoints, etc.
work: clear
A known solution is (to be) implemented.
Is your feature request related to a problem? Please describe.
Currently, there is no easily visible documentation for which arguments a component accepts.
The args builders are largely hidden from documentation.
Describe the solution you'd like
Ideally, the parameters docs should be appended as bulleted list to the documentation of the component itself. Doc comments placed on parameter declarations should be taken into account and they should also be replicated on the builder's setter methods.
Describe alternatives you've considered
An eventual args builder rework may solve this differently, but that is still a way off.
Additional context
This issue came about because the individual component methods don't have documentation attached and as such produce warnings, but that is not directly related, since the method docs currently aren't surfaced in the IDE. (Ideally, they would be, but I'm unsure where I should put them.)
The text was updated successfully, but these errors were encountered: