Merge branch 'main' of https://github.com/Pyroxenium/Basalt2

docs/index.html

@@ -44,13 +44,24 @@
 <div id="content">
 
 <h1>Module <code>basalt</code></h1>
-<p>Basalt UI Framework main module</p>
+<p>Basalt UI Framework main module.</p>
-<p>
+<p> This is the main entry point for the Basalt UI Framework.
-
+ It provides functions for creating and managing UI elements and handling events.</p>
-</p>
+    <h3>See also:</h3>
+    <ul>
+    </ul>
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">local basalt = require(&quot;basalt&quot;)
+local mainFrame = basalt.createFrame()
+mainFrame:show()
+basalt.run()
+</pre>
+    </ul>
     <h3>Info:</h3>
     <ul>
         <li><strong>Copyright</strong>: 2025</li>
+        <li><strong>Release</strong>: 2.0</li>
         <li><strong>License</strong>: MIT</li>
         <li><strong>Author</strong>: NyoriE</li>
     </ul>
@@ -60,7 +71,8 @@
 <table class="function_list">
 	<tr>
 	<td class="name" ><a href="#basalt:create">basalt:create(type[, id])</a></td>
-	<td class="summary">Creates a new UI element</td>
+	<td class="summary">Creates a new UI element
+ Creates and returns a new UI element of the specified type</td>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#basalt:createFrame">basalt:createFrame()</a></td>
@@ -108,6 +120,7 @@
 
           <div class="section-description">
           The main Basalt instance
+ Contains all core functionality and management functions
           </div>
     <dl class="function">
     <dt>
@@ -116,19 +129,16 @@
     </dt>
     <dd>
     Creates a new UI element
+ Creates and returns a new UI element of the specified type
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">type</span>
-         string The type of element to create (e.g. "BaseFrame")
+         string The type of element to create (e.g. "Button", "Label", "BaseFrame")
         </li>
         <li><span class="parameter">id</span>
-         string Optional ID for the element
+         string Optional unique identifier for the element
          (<em>optional</em>)
         </li>
     </ul>
@@ -136,14 +146,19 @@
     <h3>Returns:</h3>
     <ol>
 
-        table The created element instance
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+        The created element instance
     </ol>
 
 
+    <h3>See also:</h3>
+    <ul>
+    </ul>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example"><span class="keyword">local</span> button = basalt.<span class="function-name">create</span>(<span class="string">"Button"</span>, <span class="string">"myButton"</span>)</pre>
+        <pre class="example"><span class="keyword">local</span> button = basalt.<span class="function-name">create</span>(<span class="string">"Button"</span>, <span class="string">"myButton"</span>)
+button:<span class="function-name">setPosition</span>(<span class="number">5</span>, <span class="number">5</span>)</pre>
     </ul>
 
 </dd>
@@ -154,10 +169,6 @@
     <dd>
     Creates and returns a new frame
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
 
     <h3>Returns:</h3>
@@ -181,10 +192,6 @@
     <dd>
     Returns the element manager instance
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
 
     <h3>Returns:</h3>
@@ -208,10 +215,6 @@
     <dd>
     Gets or creates the main frame
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
 
     <h3>Returns:</h3>
@@ -235,10 +238,6 @@
     <dd>
     Removes a scheduled update
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
     <h3>Parameters:</h3>
     <ul>
@@ -263,10 +262,6 @@
     <dd>
     Starts the Basalt runtime
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
     <h3>Parameters:</h3>
     <ul>
@@ -293,10 +288,6 @@
     <dd>
     Schedules a function to be updated
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
     <h3>Parameters:</h3>
     <ul>
@@ -326,10 +317,6 @@
     <dd>
     Sets the active frame
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
     <h3>Parameters:</h3>
     <ul>
@@ -359,10 +346,6 @@
     <dd>
     Stops the Basalt runtime
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
 
 
@@ -381,10 +364,6 @@
     <dd>
     Updates all scheduled functions
 
-    </ul>
-    </ul>
-    </ul>
-    </ul>
 
 
 
@@ -403,7 +382,7 @@
 </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 2025-02-09 15:18:44 </i>
+<i style="float:right;">Last updated 2025-02-09 15:27:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>