docs: auto generate docs

sontungexpt · Sep 21, 2023 · d392777 · d392777
1 parent 2e5deac
commit d392777
Show file tree

Hide file tree

Showing 15 changed files with 210 additions and 201 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -95,7 +95,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 

diff --git a/docs/modules/url-open.html b/docs/modules/url-open.html
@@ -114,7 +114,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </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
@@ -66,7 +66,7 @@ <h1>Module <code>url-open.modules.autocmd</code></h1>
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#change_color_highlight">change_color_highlight (user_opts, group_name)</a></td>
+	<td class="name" nowrap><a href="#change_color_highlight">change_color_highlight (opts, group_name)</a></td>
 	<td class="summary">Change the color of the highlight</td>
 	</tr>
 	<tr>
@@ -84,15 +84,15 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     <dl class="function">
     <dt>
     <a name = "change_color_highlight"></a>
-    <strong>change_color_highlight (user_opts, group_name)</strong>
+    <strong>change_color_highlight (opts, group_name)</strong>
     </dt>
     <dd>
     Change the color of the highlight
 
 
     <h3>Parameters:</h3>
     <ul>
-        <li><span class="parameter">user_opts</span>
+        <li><span class="parameter">opts</span>
             <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
          : The user options
         </li>
@@ -164,7 +164,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </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
@@ -114,7 +114,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </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
@@ -70,14 +70,22 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Call a vim command</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#delete_url_effect">delete_url_effect ()</a></td>
+	<td class="name" nowrap><a href="#check_file_patterns">check_file_patterns (file_patterns, is_excluded)</a></td>
+	<td class="summary">Check if the file path matches any of the patterns</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#delete_url_effect">delete_url_effect (group_name)</a></td>
 	<td class="summary">Delete the syntax matching rules for URLs/URIs if set.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#find_url">find_url (user_opts, text, start_pos)</a></td>
+	<td class="name" nowrap><a href="#find_first_url_in_text">find_first_url_in_text (user_opts, text, start_pos)</a></td>
 	<td class="summary">Find the first url in the text</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#find_first_url_matching_patterns">find_first_url_matching_patterns (text, patterns, start_pos, found_url_smaller_pos)</a></td>
+	<td class="summary">Check if the text contains any of the patterns</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#highlight_cursor_url">highlight_cursor_url (user_opts)</a></td>
 	<td class="summary">Highlight the url under the cursor</td>
 	</tr>
@@ -123,24 +131,63 @@ <h3>Parameters:</h3>
 
 
 
+</dd>
+    <dt>
+    <a name = "check_file_patterns"></a>
+    <strong>check_file_patterns (file_patterns, is_excluded)</strong>
+    </dt>
+    <dd>
+    Check if the file path matches any of the patterns
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">file_patterns</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
+         : Patterns to match the file path
+        </li>
+        <li><span class="parameter">is_excluded</span>
+            <span class="types"><span class="type">boolean</span></span>
+         : If the file path is excluded (optional) (default: false)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">boolean</span></span>
+        : True if the file path matches any of the patterns, otherwise false
+    </ol>
+
+
+
+
 </dd>
     <dt>
     <a name = "delete_url_effect"></a>
-    <strong>delete_url_effect ()</strong>
+    <strong>delete_url_effect (group_name)</strong>
     </dt>
     <dd>
     Delete the syntax matching rules for URLs/URIs if set.
 
 
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">group_name</span>
+
+
+
+        </li>
+    </ul>
 
 
 
 
 
 </dd>
     <dt>
-    <a name = "find_url"></a>
-    <strong>find_url (user_opts, text, start_pos)</strong>
+    <a name = "find_first_url_in_text"></a>
+    <strong>find_first_url_in_text (user_opts, text, start_pos)</strong>
     </dt>
     <dd>
     Find the first url in the text
@@ -158,17 +205,55 @@ <h3>Parameters:</h3>
         </li>
         <li><span class="parameter">start_pos</span>
             <span class="types"><span class="type">number</span></span>
-         : Start position to search from (optional) (default: 0)
+         : Start position to search from (optional) (default: 1)
         </li>
     </ul>
 
     <h3>Returns:</h3>
     <ol>
 
-        start<em>pos, end</em>pos, url: Start position, end position, and url of the first url found (all nil if not found)
+           <span class="types"><span class="type">number</span></span>
+        start<em>pos, number end</em>pos, string url: Start position, end position, and url of the first url found (all nil if not found)
     </ol>
 
 
+    <h3>See also:</h3>
+    <ul>
+         <a href="../modules/url-open.modules.patterns.html#">url-open.modules.patterns</a>
+    </ul>
+
+
+</dd>
+    <dt>
+    <a name = "find_first_url_matching_patterns"></a>
+    <strong>find_first_url_matching_patterns (text, patterns, start_pos, found_url_smaller_pos)</strong>
+    </dt>
+    <dd>
+    Check if the text contains any of the patterns
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">text</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
+          : Text to search for patterns
+        </li>
+        <li><span class="parameter">patterns</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
+         : Patterns to search for urls in the text
+        </li>
+        <li><span class="parameter">start_pos</span>
+            <span class="types"><span class="type">number</span></span>
+         : Start position to search from (optional) (default: 0)
+        </li>
+        <li><span class="parameter">found_url_smaller_pos</span>
+            <span class="types"><span class="type">number</span></span>
+         : The position of the found url must be smaller than this number (optional) (default: string.len(text))
+        </li>
+    </ul>
+
+
+
     <h3>See also:</h3>
     <ul>
          <a href="../modules/url-open.modules.patterns.html#">url-open.modules.patterns</a>
@@ -256,7 +341,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </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
@@ -65,10 +65,6 @@ <h1>Module <code>url-open.modules.logger</code></h1>
 
 <h2><a href="#Functions">Functions</a></h2>
 <table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#debug">debug (msg[, opts])</a></td>
-	<td class="summary">Show debug level notification</td>
-	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#error">error (msg[, opts])</a></td>
 	<td class="summary">Show error level notification</td>
@@ -78,14 +74,6 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Show info level notification</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#off">off (msg[, opts])</a></td>
-	<td class="summary">Show off level notification</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#trace">trace (msg[, opts])</a></td>
-	<td class="summary">Show trace level notification</td>
-	</tr>
-	<tr>
 	<td class="name" nowrap><a href="#warn">warn (msg[, opts])</a></td>
 	<td class="summary">Show warn level notification</td>
 	</tr>
@@ -98,32 +86,6 @@ <h2><a href="#Functions">Functions</a></h2>
     <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 
     <dl class="function">
-    <dt>
-    <a name = "debug"></a>
-    <strong>debug (msg[, opts])</strong>
-    </dt>
-    <dd>
-    Show debug level notification
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">msg</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-         : The message to show
-        </li>
-        <li><span class="parameter">opts</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
-         : The options to pass to vim.notify
-         (<em>optional</em>)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
     <dt>
     <a name = "error"></a>
     <strong>error (msg[, opts])</strong>
@@ -175,58 +137,6 @@ <h3>Parameters:</h3>
 
 
 
-</dd>
-    <dt>
-    <a name = "off"></a>
-    <strong>off (msg[, opts])</strong>
-    </dt>
-    <dd>
-    Show off level notification
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">msg</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-         : The message to show
-        </li>
-        <li><span class="parameter">opts</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
-         : The options to pass to vim.notify
-         (<em>optional</em>)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "trace"></a>
-    <strong>trace (msg[, opts])</strong>
-    </dt>
-    <dd>
-    Show trace level notification
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">msg</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-         : The message to show
-        </li>
-        <li><span class="parameter">opts</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
-         : The options to pass to vim.notify
-         (<em>optional</em>)
-        </li>
-    </ul>
-
-
-
-
-
 </dd>
     <dt>
     <a name = "warn"></a>
@@ -261,7 +171,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </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
@@ -165,12 +165,12 @@ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
 
     <h3>Fields:</h3>
     <ul>
+        <li><span class="parameter">open_app</span>
+         : The app to open the url with
+        </li>
         <li><span class="parameter">open_only_when_cursor_on_url:</span>
          boolean : Open url only when cursor on url
         </li>
-        <li><span class="parameter">highlight_url:</span>
-         table
-        </li>
         <li><span class="parameter">deep_pattern:</span>
          boolean : Enable deep pattern
         </li>
@@ -191,7 +191,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-16 11:05:12 </i>
+<i style="float:right;">Last updated 2023-09-21 15:18:31 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->