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

V Documentation #16

Open
hassandraga opened this issue May 6, 2023 · 8 comments
Open

V Documentation #16

hassandraga opened this issue May 6, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@hassandraga
Copy link
Member

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

Local v_api.md
Online link

@malisipi
Copy link
Collaborator

malisipi commented May 6, 2023

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

@malisipi
Copy link
Collaborator

malisipi commented May 6, 2023

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

@malisipi
Copy link
Collaborator

malisipi commented May 6, 2023

@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
Copy link
Collaborator

malisipi commented May 6, 2023

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);

@hassandraga
Copy link
Member Author

Microsoft Apple Safari

What a typo! 😮‍💨

Typos fixed webui-dev/webui@e526419, webui-dev/webui@270ae1b and webui-dev/webui@47cd45e

Thank you.

@malisipi
Copy link
Collaborator

malisipi commented May 6, 2023

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 malisipi added the documentation Improvements or additions to documentation label May 7, 2023
@malisipi malisipi mentioned this issue May 9, 2023
15 tasks
@ttytm
Copy link
Member

ttytm commented Aug 29, 2023

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

@hassandraga
Copy link
Member Author

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.

@ttytm ttytm added the help wanted Extra attention is needed label Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants