moko-widgets icon indicating copy to clipboard operation
moko-widgets copied to clipboard

Lack of documentation

Open Gamadril opened this issue 5 years ago • 3 comments

I know moko-widgets is still experimental, but it would be nice to see at least basic documentation with the description of the available elements and configuration options. The mandatory size parameter is not always clear to apply. An overview would be nice. Also a description about constraints would be helpful. As far as I can see from the examples, constraints must be at the end of the container element and reference the elements by variables. But what if I create several elements in a for loop and immediately add them to a container? Is there a way to define constraints directly on the element itself after creation?

Gamadril avatar Mar 23 '20 09:03 Gamadril

hi! agree, now documentation is very bad. it because first half of dev versions constantly was with api changes. now we got much more stable api and with release 0.1.0 we add more informative docs something like https://github.com/icerockdev/moko-widgets/wiki/Widget-Gallery and also samples of usage

Alex009 avatar Mar 23 '20 13:03 Alex009

What about generating docs from source code? I looked into some files and couldn't find a line of comment describing the API or internal functions.

Gamadril avatar Apr 01 '20 09:04 Gamadril

it's good suggestion. i will try use https://github.com/Kotlin/dokka, but last time when i try it output site was not usable (ux was bad)...maybe now it better

Alex009 avatar Apr 02 '20 18:04 Alex009