Update annotations

Insality · Aug 27, 2024 · 11ae63a · 11ae63a
1 parent 5f2ae1e
commit 11ae63a
Show file tree

Hide file tree

Showing 42 changed files with 275 additions and 356 deletions.
diff --git a/.luacheckrc b/.luacheckrc
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,17 @@
+{
+	"Lua.diagnostics.globals": [
+		"init",
+		"final",
+		"update",
+		"on_message",
+		"on_input",
+		"describe",
+		"before",
+		"after",
+		"it"
+	],
+	"Lua.workspace.ignoreDir": [
+		".vscode",
+		"test/*"
+	]
+}
diff --git a/docs/modules/Button.html b/docs/modules/Button.html
@@ -360,7 +360,7 @@ <h3>Parameters:</h3>
          <a href="../modules/Button.html#">Button</a>
         </li>
         <li><span class="parameter">zone</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a> or <span class="type">nil</span></span>
+            <span class="types"><a class="type" href="../modules/Button.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
          Gui node
         </li>
     </ul>
@@ -508,19 +508,16 @@ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
     <h3>Fields:</h3>
     <ul>
         <li><span class="parameter">LONGTAP_TIME</span>
-            <span class="types"><span class="type">number</span></span>
-         Minimum time to trigger on_hold_callback
-         (<em>default</em> 0.4)
+            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
+         Minimum time to trigger on_hold_callback. Default: 0.4
         </li>
         <li><span class="parameter">AUTOHOLD_TRIGGER</span>
-            <span class="types"><span class="type">number</span></span>
-         Maximum hold time to trigger button release while holding
-         (<em>default</em> 0.8)
+            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
+         Maximum hold time to trigger button release while holding. Default: 0.8
         </li>
         <li><span class="parameter">DOUBLETAP_TIME</span>
-            <span class="types"><span class="type">number</span></span>
-         Time between double taps
-         (<em>default</em> 0.4)
+            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
+         Time between double taps. Default: 0.4
         </li>
         <li><span class="parameter">on_click</span>
             <span class="types"><span class="type">function</span></span>
@@ -565,9 +562,8 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <ul>
         <li><span class="parameter">anim_node</span>
-            <span class="types"><a class="type" href="../modules/Button.html#node">node</a></span>
-
-         (<em>default</em> node)
+            <span class="types"><a class="type" href="../modules/Button.html#node">node</a> or <span class="type">nil</span></span>
+         Default node
         </li>
     </ul>
 

diff --git a/docs/modules/Checkbox.html b/docs/modules/Checkbox.html
@@ -87,7 +87,7 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Return checkbox state</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, node, callback[, click_node=node[, initial_state=false]])</a></td>
+	<td class="name" nowrap><a href="#init">init(self, node, callback, click_node, initial_state)</a></td>
 	<td class="summary">The <a href="../modules/Checkbox.html#">Checkbox</a> constructor</td>
 	</tr>
 	<tr>
@@ -158,7 +158,7 @@ <h3>Returns:</h3>
 </dd>
     <dt>
     <a name = "init"></a>
-    <strong>init(self, node, callback[, click_node=node[, initial_state=false]])</strong>
+    <strong>init(self, node, callback, click_node, initial_state)</strong>
     </dt>
     <dd>
     The <a href="../modules/Checkbox.html#">Checkbox</a> constructor
@@ -179,14 +179,12 @@ <h3>Parameters:</h3>
          Checkbox callback
         </li>
         <li><span class="parameter">click_node</span>
-            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
-         Trigger node, by default equals to node
-         (<em>default</em> node)
+            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a> or <span class="type">nil</span></span>
+         Trigger node, by default equals to node. Default: node
         </li>
         <li><span class="parameter">initial_state</span>
-            <span class="types"><span class="type">boolean</span></span>
+            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
          The initial state of checkbox, default - false
-         (<em>default</em> false)
         </li>
     </ul>
 
@@ -289,9 +287,8 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
     <ul>
         <li><span class="parameter">click_node</span>
-            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a></span>
+            <span class="types"><a class="type" href="../modules/Checkbox.html#node">node</a> or <span class="type">nil</span></span>
 
-         (<em>default</em> node)
         </li>
     </ul>
 

diff --git a/docs/modules/CheckboxGroup.html b/docs/modules/CheckboxGroup.html
@@ -86,7 +86,7 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Return checkbox group state</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#init">init(self, nodes, callback[, click_nodes=node])</a></td>
+	<td class="name" nowrap><a href="#init">init(self, nodes, callback, click_nodes)</a></td>
 	<td class="summary">The <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> constructor</td>
 	</tr>
 	<tr>
@@ -142,7 +142,7 @@ <h3>Returns:</h3>
 </dd>
     <dt>
     <a name = "init"></a>
-    <strong>init(self, nodes, callback[, click_nodes=node])</strong>
+    <strong>init(self, nodes, callback, click_nodes)</strong>
     </dt>
     <dd>
     The <a href="../modules/CheckboxGroup.html#">CheckboxGroup</a> constructor
@@ -163,9 +163,8 @@ <h3>Parameters:</h3>
          Checkbox callback
         </li>
         <li><span class="parameter">click_nodes</span>
-            <span class="types"><span class="type">node[]</span></span>
+            <span class="types"><span class="type">node[]</span> or <span class="type">nil</span></span>
          Array of trigger nodes, by default equals to nodes
-         (<em>default</em> node)
         </li>
     </ul>
 

diff --git a/docs/modules/Drag.html b/docs/modules/Drag.html
@@ -253,7 +253,7 @@ <h3>Parameters:</h3>
          <a href="../modules/Drag.html#">Drag</a>
         </li>
         <li><span class="parameter">node</span>
-            <span class="types"><a class="type" href="../modules/Drag.html#node">node</a></span>
+            <span class="types"><a class="type" href="../modules/Drag.html#node">node</a>, <a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span>
          Gui node
         </li>
     </ul>
@@ -305,14 +305,12 @@ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
     <h3>Fields:</h3>
     <ul>
         <li><span class="parameter">DRAG_DEADZONE</span>
-            <span class="types"><span class="type">number</span></span>
-         Distance in pixels to start dragging
-         (<em>default</em> 10)
+            <span class="types"><span class="type">number</span> or <span class="type">nil</span></span>
+         Distance in pixels to start dragging. Default: 10
         </li>
         <li><span class="parameter">NO_USE_SCREEN_KOEF</span>
-            <span class="types"><span class="type">boolean</span></span>
-         If screen aspect ratio affects on drag values
-         (<em>default</em> false)
+            <span class="types"><span class="type">boolean</span> or <span class="type">nil</span></span>
+         If screen aspect ratio affects on drag values. Default: false
         </li>
     </ul>