slint icon indicating copy to clipboard operation
slint copied to clipboard

Generate widget style documentation

Open tronical opened this issue 2 years ago • 2 comments

We should extend our parser to become aware of perhaps triple-slash comments before components, properties, and callbacks. Then the compiler could have a new output mode that would be "markdown" and that would be the content of these comments, along with tables/lists for the properties, and references to the docs of known types.

Initially, we could use this to generate the widget style documentation - by moving it from hand-written markdown to say the fluent style, generate the markdown and check in the generate markdown like we do for enums.

tronical avatar Jan 11 '23 15:01 tronical

We should add //< at the same time to relate comments to the previous token. That is really handy in some cases.

I'll adapt my comment removal logic to only include these comments once this lands.

hunger avatar Jan 12 '23 12:01 hunger

Duplicate of #104

tronical avatar Jan 23 '24 12:01 tronical