V Documentation

[hassandraga]

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]

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

[malisipi]

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

[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]

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]

Microsoft Apple Safari

What a typo! 😮‍💨

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

Thank you.

[malisipi]

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

[ttytm]

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]

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.

[StephaneTy-Pro]

perhaps this subject is not actual but there could be a solution for universal doc generated
i use ypp : https://github.com/CDSoft/ypp more precisely https://github.com/CDSoft/ypp?tab=readme-ov-file#doc
it imposes some rules as marker

this is not a perfect solution, but some foundation for a good one i think

****** sample (two files doc a.lua, a.js stored in /src
-- file:test.ypp --
@@( src=string.format("%s/%s",ypp.input_path(), "src/a.lua") )@comment( " construct full path from script " )
@doc( src ) @comment( " use default pattern " )
@@( src=string.format("%s/%s",ypp.input_path(), "src/a.js") )
@doc( src ) {pattern="/*//(.-) //*/"}

@comment [===[
  - my lua file doc is commented using defaut comment for doc
  - my js file is commented using  /*//   and   //*/ (try not to change too much from standard )
]===]


----------- command
$> ./ypp -o dest.txt test.ypp
---------------------------

final doc contain the content of all elements of the files between the marker, i never try the option to format to specific forms (rst ...)

****** /sample

i really love to use it, because it gives tool to manipulate raw text, and because it's lua you could do much more ( @ypp.include + openresty.template module is awesome)

---

by the way if you could add information on script_options ... it make me mad until i found that return message is by default limited to 8192 bytes which truncated returned data ;)

[AlbertShown]

Where can I find a generated docs example?

[StephaneTy-Pro]

you could look at ypp doc but i think the sample is not really descriptive, you' d better look at generated samples of the tool to decide if it was usable as a doc generator ; because it was not doc dedicated but dedicated to preprocess any text ; as i said "this is not a perfect solution, but some foundation for a good one".