Improve class.lua documentation

Firanel · Dec 30, 2022 · 27676c3 · 27676c3
1 parent cf39d56
commit 27676c3
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 26 deletions.
diff --git a/docs/classes/Color.html b/docs/classes/Color.html
@@ -1422,7 +1422,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -84,7 +84,7 @@ <h2>Topics</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.colors.X11.html b/docs/modules/lua-color.colors.X11.html
@@ -76,7 +76,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.colors.html b/docs/modules/lua-color.colors.html
@@ -197,7 +197,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.terminal.html b/docs/modules/lua-color.terminal.html
@@ -260,7 +260,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/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html
@@ -79,7 +79,7 @@ <h2>Features</h2>
 <h2>Install</h2>
 
 <p>Use <code>luarocks install lua-color</code> or add folder to your project root. <br/>
-Supports lua >= 5.3.</p>
+Supports lua >= 5.1.</p>
 
 <p><a name="Documentation"></a></p>
 <h2>Documentation</h2>
@@ -269,7 +269,7 @@ <h3>Terminal colors</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
+<i style="float:right;">Last updated 2022-12-30 15:01:58 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/util/class.lua b/util/class.lua
@@ -1,23 +1,14 @@
---
---------------------------------------------------------------------------------
---         File:  class.lua
---
---        Usage:  ./class.lua
---
---  Description:  
---
---      Options:  ---
--- Requirements:  ---
---         Bugs:  ---
---        Notes:  ---
---       Author:  YOUR NAME (), <>
--- Organization:  
---      Version:  1.0
---      Created:  15.04.2021
---     Revision:  ---
---------------------------------------------------------------------------------
---
+-- Code based on:
+-- http://lua-users.org/wiki/SimpleLuaClasses
 
+--- Helper function to create classes
+--
+-- @usage local Color = class(function () --[[ constructor ]] end)
+-- @usage local Color2 = class(
+--   Color,
+--   function () --[[ constructor ]] end,
+--   { prop_a = "some value" }
+-- )
 local function class(base, init, defaults)
   local c = defaults or {}    -- a new class instance
   if not init and type(base) == 'function' then