docs: auto gen docs

sontungexpt · Nov 17, 2023 · a088e71 · a088e71
1 parent 9efc8cb
commit a088e71
Show file tree

Hide file tree

Showing 18 changed files with 153 additions and 45 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -100,7 +100,7 @@ <h2>Topics</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/lua.url-open.html b/docs/modules/lua.url-open.html
@@ -145,6 +145,19 @@ <h3>Usage:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.autocmd.html b/docs/modules/lua.url-open.modules.autocmd.html
@@ -147,6 +147,19 @@ <h3>Usage:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.commands.html b/docs/modules/lua.url-open.modules.commands.html
@@ -147,6 +147,19 @@ <h3>Usage:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.handlers.html b/docs/modules/lua.url-open.modules.handlers.html
@@ -400,6 +400,19 @@ <h3>See also:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.highlight.html b/docs/modules/lua.url-open.modules.highlight.html
@@ -231,6 +231,19 @@ <h3>See also:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.logger.html b/docs/modules/lua.url-open.modules.logger.html
@@ -202,6 +202,19 @@ <h3>Parameters:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.options.html b/docs/modules/lua.url-open.modules.options.html
@@ -269,6 +269,19 @@ <h3>Fields:</h3>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/lua.url-open.modules.patterns.html b/docs/modules/lua.url-open.modules.patterns.html
@@ -200,6 +200,19 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
     td.removeAttribute("nowrap");
   });
 </script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
 <script>
   let links = document.querySelectorAll("a[name]");
   links.forEach(function(link) {

diff --git a/docs/modules/url-open.html b/docs/modules/url-open.html
@@ -115,7 +115,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.autocmd.html b/docs/modules/url-open.modules.autocmd.html
@@ -117,7 +117,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.commands.html b/docs/modules/url-open.modules.commands.html
@@ -117,7 +117,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.handlers.html b/docs/modules/url-open.modules.handlers.html
@@ -66,10 +66,6 @@ <h1>Module <code>url-open.modules.handlers</code></h1>
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#call_cmd">call_cmd (command, msg)</a></td>
-	<td class="summary">Call a vim command</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#find_first_matching_url">find_first_matching_url (text, patterns, start_pos, found_url_smaller_pos)</a></td>
 	<td class="summary">Find the first url in the text that matches any of the patterns</td>
@@ -79,6 +75,10 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Find the first url in the line</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#foreach_url_in_line">foreach_url_in_line (user_opts, line, callback)</a></td>
+	<td class="summary">Iterate through all urls in the line</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#matches_condition_pattern">matches_condition_pattern (pattern_found, condition)</a></td>
 	<td class="summary">Check if the pattern found matches the condition</td>
 	</tr>
@@ -108,31 +108,6 @@ <h2><a href="#Functions">Functions</a></h2>
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "call_cmd"></a>
-    <strong>call_cmd (command, msg)</strong>
-    </dt>
-    <dd>
-    Call a vim command
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">command</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-         : The command to execute
-        </li>
-        <li><span class="parameter">msg</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
-         : The message to print on success or error
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "find_first_matching_url"></a>
     <strong>find_first_matching_url (text, patterns, start_pos, found_url_smaller_pos)</strong>
@@ -210,6 +185,39 @@ <h3>See also:</h3>
     </ul>
 
 
+</dd>
+    <dt>
+    <a name = "foreach_url_in_line"></a>
+    <strong>foreach_url_in_line (user_opts, line, callback)</strong>
+    </dt>
+    <dd>
+    Iterate through all urls in the line
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">user_opts</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
+         : User options
+        </li>
+        <li><span class="parameter">line</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
+         : The line to iterate through
+        </li>
+        <li><span class="parameter">callback</span>
+            <span class="types"><span class="type">function</span></span>
+         : The callback function to call for each url
+        </li>
+    </ul>
+
+
+
+    <h3>See also:</h3>
+    <ul>
+         <a href="../modules/url-open.modules.handlers.html#find_first_url_in_line">url-open.modules.handlers.find_first_url_in_line</a>
+    </ul>
+
+
 </dd>
     <dt>
     <a name = "matches_condition_pattern"></a>
@@ -327,10 +335,6 @@ <h3>Parameters:</h3>
 
 
 
-    <h3>See also:</h3>
-    <ul>
-         <a href="../modules/url-open.modules.handlers.html#call_cmd">url-open.modules.handlers.call_cmd</a>
-    </ul>
 
 
 </dd>
@@ -370,7 +374,7 @@ <h3>See also:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.highlight.html b/docs/modules/url-open.modules.highlight.html
@@ -201,7 +201,7 @@ <h3>See also:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.logger.html b/docs/modules/url-open.modules.logger.html
@@ -172,7 +172,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.options.html b/docs/modules/url-open.modules.options.html
@@ -239,7 +239,7 @@ <h3>Fields:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.modules.patterns.html b/docs/modules/url-open.modules.patterns.html
@@ -170,7 +170,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html
@@ -135,7 +135,7 @@ <h2>Installation</h2>
 
 
 <ul>
-    <li>NOTE: If you want to use minimal source with no commnets, no validate configs, no documents,
+    <li>NOTE: If you want to use minimal source with no comments, no validate configs, no documents,
     you can use branch <code>mini</code> instead of <code>main</code> branch. Make sure you know that your config is valid</li>
 </ul>
 
@@ -165,7 +165,7 @@ <h2>Configuration</h2>
 
 <pre>
 <span class="comment">-- default values
-</span><span class="global">require</span>(<span class="string">"url_open"</span>).<span class="function-name">setup</span>({
+</span><span class="global">require</span>(<span class="string">"url-open"</span>).<span class="function-name">setup</span>({
     <span class="comment">-- default will open url with default browser of your system or you can choose your browser like this
 </span>    <span class="comment">-- open_app = "micorsoft-edge-stable",
 </span>    <span class="comment">-- google-chrome, firefox, micorsoft-edge-stable, opera, brave, vivaldi
@@ -254,7 +254,7 @@ <h2>License</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-24 10:02:27 </i>
+<i style="float:right;">Last updated 2023-11-17 07:26:28 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->