v-webui icon indicating copy to clipboard operation
v-webui copied to clipboard

V Documentation

Open hassandraga opened this issue 2 years ago • 11 comments

I quickly started the V documentation (copy of the C documentation), but I still need to finish it.

Local v_api.md Online link

hassandraga avatar May 06 '23 18:05 hassandraga

I will finish until tomorrow evening. You can sure about it.

malisipi avatar May 06 '23 19:05 malisipi

Also i found a few missing features on V #17. I will fix it asap.

malisipi avatar May 06 '23 21:05 malisipi

@hassandraga Also C (and other languages?) documentations needs to be updates

returns a void pointer

### New Window

To create a new window object, you can use `webui_new_window()`, which returns a void pointer. Please note that this pointer does *NOT* need to be freed.

Note: For V, it's still correct. V is still using voidptr datatype for flexibility. (It's not require any change of C base, it's defined as it in only V)

malisipi avatar May 06 '23 21:05 malisipi

And Microsoft Browsers

// Microsoft Apple Safari (Not Ready)
webui_show_browser(my_window, my_html, Safari);
// Microsoft Opera Browser (Not Ready)
webui_show_browser(my_window, my_html, Opera);

malisipi avatar May 06 '23 21:05 malisipi

Microsoft Apple Safari

What a typo! 😮‍💨

Typos fixed https://github.com/alifcommunity/webui/commit/e52641995681ad49c906346ca8f7882f71e6fe73, https://github.com/alifcommunity/webui/commit/270ae1b0c4325e68c6b66a89fbc7a0ad5bb3efed and https://github.com/alifcommunity/webui/commit/47cd45e4581b8024c654c33d290dcecb4edccb50

Thank you.

hassandraga avatar May 06 '23 21:05 hassandraga

Typos is the worst thing in writing documentations. You can not find it without reading entire documentation a few times.

Also, i made a PR that update the V docs

malisipi avatar May 06 '23 22:05 malisipi

What do you guys think of using the automatically generated v doc feature? It could be set up to automatically generate on changes to the main branch.

Would result in something like: https://ttytm.github.io/webview/webview.html

ttytm avatar Aug 29 '23 01:08 ttytm

I already taught about that, but as I know, there is no way to auto-generate docs for all wrappers in all used languages using the same tool. I think using different tools and themes for each wrapper isn't a good idea. So, right now, we are stuck with the manual writing.

hassandraga avatar Aug 29 '23 02:08 hassandraga