diff options
| author | Akshay Nair <phenax5@gmail.com> | 2025-08-12 00:57:42 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2025-08-12 00:57:42 +0530 |
| commit | 211e953db7775a1192a5535041e9abb7588bc5fa (patch) | |
| tree | c902d10ee6985f285b71ac5359bc4e2b7d0816a8 /doc | |
| parent | 0623db559013a321d3d87a064c0defb9e01763dc (diff) | |
| download | null-browser-211e953db7775a1192a5535041e9abb7588bc5fa.tar.gz null-browser-211e953db7775a1192a5535041e9abb7588bc5fa.zip | |
Move generated api reference dir
Diffstat (limited to '')
| -rw-r--r-- | docs/api/index.html (renamed from doc/index.html) | 84 | ||||
| -rw-r--r-- | docs/api/ldoc.css (renamed from doc/ldoc.css) | 0 | ||||
| -rw-r--r-- | docs/api/symbols.json (renamed from doc/symbols.json) | 2 |
3 files changed, 85 insertions, 1 deletions
diff --git a/doc/index.html b/docs/api/index.html index f357409..fa2ab5a 100644 --- a/doc/index.html +++ b/docs/api/index.html @@ -169,6 +169,14 @@ <td class="summary">TODO: Document</td> </tr> <tr> + <td class="name" nowrap><a href="#web.help.get_items">web.help.get_items ()</a></td> + <td class="summary">Get a list of items for help</td> + </tr> + <tr> + <td class="name" nowrap><a href="#web.help.show">web.help.show (item, opts)</a></td> + <td class="summary">Open help docs for a given item</td> + </tr> + <tr> <td class="name" nowrap><a href="#web.utils.string_trim">web.utils.string_trim (str)</a></td> <td class="summary">Trim whitespace from start and end of a string</td> </tr> @@ -184,6 +192,10 @@ <td class="name" nowrap><a href="#web.utils.equals">web.utils.equals (a, b)</a></td> <td class="summary">Check if 2 values are deeply equal</td> </tr> + <tr> + <td class="name" nowrap><a href="#web.utils.table_contains">web.utils.table_contains (tbl, value)</a></td> + <td class="summary">Check if table contains given value</td> + </tr> </table> <h2><a href="#Tables">Tables</a></h2> <table class="function_list"> @@ -987,6 +999,47 @@ web.view.<span class="function-name">reload</span>({ view = <span class="number" </dd> <dt> + <a name = "web.help.get_items"></a> + <strong>web.help.get_items ()</strong> + </dt> + <dd> + Get a list of items for help + + + + + + + +</dd> + <dt> + <a name = "web.help.show"></a> + <strong>web.help.show (item, opts)</strong> + </dt> + <dd> + Open help docs for a given item + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">item</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + + </li> + <li><span class="parameter">opts</span> + <ul> + <li><span class="parameter">view</span> + number? + </li> + </li></ul> + </ul> + + + + + +</dd> + <dt> <a name = "web.utils.string_trim"></a> <strong>web.utils.string_trim (str)</strong> </dt> @@ -1098,6 +1151,37 @@ web.view.<span class="function-name">reload</span>({ view = <span class="number" </dd> + <dt> + <a name = "web.utils.table_contains"></a> + <strong>web.utils.table_contains (tbl, value)</strong> + </dt> + <dd> + Check if table contains given value + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">tbl</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> + + </li> + <li><span class="parameter">value</span> + <span class="types"><span class="type">any</span></span> + + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><span class="type">boolean</span></span> + + </ol> + + + + +</dd> </dl> <h2 class="section-header "><a name="Tables"></a>Tables</h2> diff --git a/doc/ldoc.css b/docs/api/ldoc.css index f945ae7..f945ae7 100644 --- a/doc/ldoc.css +++ b/docs/api/ldoc.css diff --git a/doc/symbols.json b/docs/api/symbols.json index 8766314..aa356c5 100644 --- a/doc/symbols.json +++ b/docs/api/symbols.json @@ -1 +1 @@ -["_G.__internals","schedule","web.keymap.set","web.keymap.set_mode","web.keymap.get_mode","web.view.close","web.view.create","web.view.current","web.view.list","web.view.select","web.view.set_url","web.view.set_html","web.view.run_js","web.view.reload","web.view.expose","web.view.open_devtools","web.view.current_index","web.event.add_listener","set","get","WebOpts","opts","web.history.back","web.history.forward","web.search.set_text","web.search.reset","web.search.get_text","web.search.next","web.search.previous","web.view.scroll","web.view.scroll_to_top","web.view.scroll_to_bottom","uv","inspect","web.utils.string_trim","web.utils.table_merge","web.utils.table_keys","web.utils.equals","web.utils.table_contains"]
\ No newline at end of file +["_G.__internals","schedule","web.keymap.set","web.keymap.set_mode","web.keymap.get_mode","web.view.close","web.view.create","web.view.current","web.view.list","web.view.select","web.view.set_url","web.view.set_html","web.view.run_js","web.view.reload","web.view.expose","web.view.open_devtools","web.view.current_index","web.event.add_listener","set","get","WebOpts","opts","web.history.back","web.history.forward","web.search.set_text","web.search.reset","web.search.get_text","web.search.next","web.search.previous","web.view.scroll","web.view.scroll_to_top","web.view.scroll_to_bottom","web.help.get_items","web.help.show","uv","inspect","web.utils.string_trim","web.utils.table_merge","web.utils.table_keys","web.utils.equals","web.utils.table_contains"]
\ No newline at end of file |
